marlin_host.h File Reference

#include <inttypes.h>

Go to the source code of this file.

Classes
struct	_marlin_host_prompt_t

Macros
#define	HOST_PROMPT_MAX_BUTTONS   4
#define	MARLIN_HOSTPROMPT_LoadFilament   0x01
#define	MARLIN_HOSTPROMPT_Paused   0x02
#define	MARLIN_HOSTPROMPT_BTN_Continue   0x01
#define	MARLIN_HOSTPROMPT_BTN_PurgeMore   0x02

Typedefs
typedef struct _marlin_host_prompt_t	marlin_host_prompt_t

Enumerations
enum	host_prompt_type_t {   HOST_PROMPT_None = 0, HOST_PROMPT_Paused, HOST_PROMPT_FilamentRunout, HOST_PROMPT_LoadFilament,   HOST_PROMPT_END }
enum	host_prompt_button_t {   HOST_PROMPT_BTN_None = 0, HOST_PROMPT_BTN_Continue, HOST_PROMPT_BTN_PurgeMore, HOST_PROMPT_BTN_DisableRunout,   HOST_PROMPT_BTN_END }
enum	host_prompt_reason_t {   HOST_PROMPT_RSN_NOT_DEFINED, HOST_PROMPT_RSN_FILAMENT_RUNOUT, HOST_PROMPT_RSN_USER_CONTINUE, HOST_PROMPT_RSN_FILAMENT_RUNOUT_REHEAT,   HOST_PROMPT_RSN_PAUSE_RESUME, HOST_PROMPT_RSN_INFO }

Functions
const char *	marlin_host_prompt_get_text (host_prompt_type_t type)
host_prompt_type_t	marlin_host_prompt_by_text (const char *text)
const char *	marlin_host_prompt_button_get_text (host_prompt_button_t button)
host_prompt_button_t	marlin_host_prompt_button_by_text (const char *text)
uint32_t	marlin_host_prompt_encode (marlin_host_prompt_t *prompt)
void	marlin_host_prompt_decode (uint32_t ui32, marlin_host_prompt_t *prompt)

Macro Definition Documentation

HOST_PROMPT_MAX_BUTTONS

#define HOST_PROMPT_MAX_BUTTONS   4

MARLIN_HOSTPROMPT_LoadFilament

#define MARLIN_HOSTPROMPT_LoadFilament   0x01

MARLIN_HOSTPROMPT_Paused

#define MARLIN_HOSTPROMPT_Paused   0x02

MARLIN_HOSTPROMPT_BTN_Continue

#define MARLIN_HOSTPROMPT_BTN_Continue   0x01

MARLIN_HOSTPROMPT_BTN_PurgeMore

#define MARLIN_HOSTPROMPT_BTN_PurgeMore   0x02

Typedef Documentation

marlin_host_prompt_t

typedef struct _marlin_host_prompt_t marlin_host_prompt_t

Enumeration Type Documentation

host_prompt_type_t

enum host_prompt_type_t

Enumerator
HOST_PROMPT_None
HOST_PROMPT_Paused
HOST_PROMPT_FilamentRunout
HOST_PROMPT_LoadFilament
HOST_PROMPT_END

             {
    HOST_PROMPT_None = 0,
    HOST_PROMPT_Paused,
    HOST_PROMPT_FilamentRunout,
    HOST_PROMPT_LoadFilament,
    HOST_PROMPT_END,
} host_prompt_type_t;

host_prompt_button_t

enum host_prompt_button_t

Enumerator
HOST_PROMPT_BTN_None
HOST_PROMPT_BTN_Continue
HOST_PROMPT_BTN_PurgeMore
HOST_PROMPT_BTN_DisableRunout
HOST_PROMPT_BTN_END

             {
    HOST_PROMPT_BTN_None = 0,
    HOST_PROMPT_BTN_Continue,
    HOST_PROMPT_BTN_PurgeMore,
    HOST_PROMPT_BTN_DisableRunout,
    HOST_PROMPT_BTN_END,
} host_prompt_button_t;

host_prompt_reason_t

enum host_prompt_reason_t

Enumerator
HOST_PROMPT_RSN_NOT_DEFINED
HOST_PROMPT_RSN_FILAMENT_RUNOUT
HOST_PROMPT_RSN_USER_CONTINUE
HOST_PROMPT_RSN_FILAMENT_RUNOUT_REHEAT
HOST_PROMPT_RSN_PAUSE_RESUME
HOST_PROMPT_RSN_INFO

             {
    HOST_PROMPT_RSN_NOT_DEFINED,
    HOST_PROMPT_RSN_FILAMENT_RUNOUT,
    HOST_PROMPT_RSN_USER_CONTINUE,
    HOST_PROMPT_RSN_FILAMENT_RUNOUT_REHEAT,
    HOST_PROMPT_RSN_PAUSE_RESUME,
    HOST_PROMPT_RSN_INFO,
} host_prompt_reason_t;

Function Documentation

marlin_host_prompt_get_text()

const char* marlin_host_prompt_get_text

(

host_prompt_type_t

type

)

                                                                 {
    uint8_t index = (uint8_t)type;
    if (index < HOST_PROMPT_END)
        return __prompt_text[index];
    return "";
}

marlin_host_prompt_by_text()

host_prompt_type_t marlin_host_prompt_by_text

(

const char *

text

)

                                                                {
    uint8_t index;
    for (index = 0; index < HOST_PROMPT_END; index++)
        if (strcmp(text, __prompt_text[index]) == 0)
            return (host_prompt_type_t)index;
    return HOST_PROMPT_None;
}

Here is the caller graph for this function:

marlin_host_prompt_button_get_text()

const char* marlin_host_prompt_button_get_text

(

host_prompt_button_t

button

)

                                                                            {
    uint8_t index = (uint8_t)button;
    if (index < HOST_PROMPT_BTN_END)
        return __prompt_text[index];
    return "";
}

marlin_host_prompt_button_by_text()

host_prompt_button_t marlin_host_prompt_button_by_text

(

const char *

text

)

                                                                         {
    uint8_t index;
    for (index = 0; index < HOST_PROMPT_BTN_END; index++)
        if (strcmp(text, __prompt_button_text[index]) == 0)
            return (host_prompt_button_t)index;
    return HOST_PROMPT_BTN_None;
}

Here is the caller graph for this function:

marlin_host_prompt_encode()

uint32_t marlin_host_prompt_encode

(

marlin_host_prompt_t *

prompt

)

                                                                 {
    return ((uint32_t)prompt->type & 0xf) | (((uint32_t)prompt->button_count & 0xf) << 4) | (((uint32_t)prompt->button[0] & 0xf) << 8) | (((uint32_t)prompt->button[1] & 0xf) << 12) | (((uint32_t)prompt->button[2] & 0xf) << 16) | (((uint32_t)prompt->button[3] & 0xf) << 20);
}

Here is the caller graph for this function:

marlin_host_prompt_decode()

void marlin_host_prompt_decode	(	uint32_t	ui32,
		marlin_host_prompt_t *	prompt
	)

                                                                            {
    prompt->type = ui32 & 0xf;
    prompt->button_count = (ui32 >> 4) & 0xf;
    prompt->button[0] = (ui32 >> 8) & 0xf;
    prompt->button[1] = (ui32 >> 12) & 0xf;
    prompt->button[2] = (ui32 >> 16) & 0xf;
    prompt->button[3] = (ui32 >> 20) & 0xf;
}

Here is the caller graph for this function: