command.h File Reference

#include "moddef/device.h"

Go to the source code of this file.

Data Structures
struct	md_cmd_param
struct	md_cmd_params
struct	md_cmd_binding
struct	md_cmd_exec

Macros
#define	MD_CMD_MAX_BINDINGS   4
#define	MD_CMD_MAX_WRITE_WORDS   123
#define	MD_CMD_DEFAULT_INTERVAL_MS   250

Typedefs
typedef enum md_cmd_status	md_cmd_status_t
typedef enum md_cmd_param_kind	md_cmd_param_kind_t
typedef struct md_cmd_param	md_cmd_param_t
typedef struct md_cmd_params	md_cmd_params_t
typedef struct md_cmd_binding	md_cmd_binding_t
typedef struct md_cmd_exec	md_cmd_exec_t

Enumerations
enum	md_cmd_status { MD_CMD_RUNNING = 0 , MD_CMD_WAITING_POLL , MD_CMD_DONE , MD_CMD_ERROR }
enum	md_cmd_param_kind { MD_CMD_PARAM_VALUE = 0 , MD_CMD_PARAM_STR , MD_CMD_PARAM_BYTES }

Functions
md_err_t	md_cmd_begin (md_cmd_exec_t *ex, md_dev_t *dev, md_str_t command_id, const md_cmd_params_t *params, uint8_t *data_buf, size_t data_cap)
md_cmd_status_t	md_cmd_tick (md_cmd_exec_t *ex, uint32_t now_ms)
md_err_t	md_cmd_error (const md_cmd_exec_t *ex)
md_err_t	md_cmd_result (const md_cmd_exec_t *ex, md_str_t field, md_value_t *out)
md_err_t	md_cmd_result_data (const md_cmd_exec_t *ex, md_str_t field, const uint8_t **p, size_t *len)

Macro Definition Documentation

MD_CMD_DEFAULT_INTERVAL_MS

#define MD_CMD_DEFAULT_INTERVAL_MS   250

MD_CMD_MAX_BINDINGS

#define MD_CMD_MAX_BINDINGS   4

MD_CMD_MAX_WRITE_WORDS

#define MD_CMD_MAX_WRITE_WORDS   123

Typedef Documentation

md_cmd_binding_t

typedef struct md_cmd_binding md_cmd_binding_t

md_cmd_exec_t

typedef struct md_cmd_exec md_cmd_exec_t

md_cmd_param_kind_t

typedef enum md_cmd_param_kind md_cmd_param_kind_t

md_cmd_param_t

typedef struct md_cmd_param md_cmd_param_t

md_cmd_params_t

typedef struct md_cmd_params md_cmd_params_t

md_cmd_status_t

typedef enum md_cmd_status md_cmd_status_t

Enumeration Type Documentation

md_cmd_param_kind

enum md_cmd_param_kind

Enumerator
MD_CMD_PARAM_VALUE
MD_CMD_PARAM_STR
MD_CMD_PARAM_BYTES

md_cmd_status

enum md_cmd_status

Enumerator
MD_CMD_RUNNING
MD_CMD_WAITING_POLL
MD_CMD_DONE
MD_CMD_ERROR

Function Documentation

md_cmd_begin()

md_err_t md_cmd_begin	(	md_cmd_exec_t *	ex,
		md_dev_t *	dev,
		md_str_t	command_id,
		const md_cmd_params_t *	params,
		uint8_t *	data_buf,
		size_t	data_cap
	)

md_cmd_error()

md_err_t md_cmd_error

(

const md_cmd_exec_t *

ex

)

md_cmd_result()

md_err_t md_cmd_result	(	const md_cmd_exec_t *	ex,
		md_str_t	field,
		md_value_t *	out
	)

md_cmd_result_data()

md_err_t md_cmd_result_data	(	const md_cmd_exec_t *	ex,
		md_str_t	field,
		const uint8_t **	p,
		size_t *	len
	)

md_cmd_tick()

md_cmd_status_t md_cmd_tick	(	md_cmd_exec_t *	ex,
		uint32_t	now_ms
	)