mcif.h

Go to the documentation of this file.

 
#ifndef MCIF_H
#define MCIF_H
#include "osal.h"
 
 
#define MCIF_CLIENTS_NR 1
 
#ifndef MCIF_USE_TASK_NOTIFICATIONS
#define MCIF_USE_TASK_NOTIFICATIONS 0
#endif
 
#ifndef MCIF_MAX_ARGS
#define MCIF_MAX_ARGS 2
#endif
 
#ifndef MCIF_UART
#define MCIF_UART HW_UART1
#endif
 
#ifndef MCIF_GPIO_PORT_UART_RX
#define MCIF_GPIO_PORT_UART_RX HW_GPIO_PORT_1
#endif
 
#ifndef MCIF_GPIO_PIN_UART_RX
#define MCIF_GPIO_PIN_UART_RX HW_GPIO_PIN_5
#endif
 
#ifndef MCIF_GPIO_PORT_UART_TX
#define MCIF_GPIO_PORT_UART_TX HW_GPIO_PORT_1
#endif
 
#ifndef MCIF_GPIO_PIN_UART_TX
#define MCIF_GPIO_PIN_UART_TX HW_GPIO_PIN_0
#endif
 
 
#ifndef MCIF_UART_BAUDRATE
#define MCIF_UART_BAUDRATE HW_UART_BAUDRATE_115200
#endif
 
#ifndef MCIF_UART_DATABITS
#define MCIF_UART_DATABITS HW_UART_DATABITS_8
#endif
 
#ifndef MCIF_UART_STOPBITS
#define MCIF_UART_STOPBITS HW_UART_STOPBITS_1
#endif
 
#ifndef MCIF_UART_PARITY
#define MCIF_UART_PARITY HW_UART_PARITY_NONE
#endif
 
#ifndef MCIF_LOG_TAG
#define MCIF_LOG_TAG 30
#endif
 
#ifndef MCIF_ASCII_MAX_LINE
#define MCIF_ASCII_MAX_LINE 80
#endif
 
#ifndef MCIF_UART_DMA_BUFFER
#define MCIF_UART_DMA_BUFFER MCIF_ASCII_MAX_LINE
#else
#if (MCIF_UART_DMA_BUFFER < MCIF_ASCII_MAX_LINE)
#undef MCIF_UART_DMA_BUFFER
#define MCIF_UART_DMA_BUFFER MCIF_ASCII_MAX_LINE
#endif
#endif
 
#ifndef MCIF_ASCII_PROMPT
#define MCIF_ASCII_PROMPT "\r\nEnter command (or ?/help for help) > "
#endif
 
 
struct mcif_message_s {
        uint16_t len; 
        char  buffer[0]; 
};
 
 
#define MCIF_ASCII_FLAGS_MASK 0x3
 
#define MCIF_ASCII_FLAGS_ARG1_NA 0x0
#define MCIF_ASCII_FLAGS_ARG2_NA 0x0
#define MCIF_ASCII_FLAGS_ARG3_NA 0x0
#define MCIF_ASCII_FLAGS_ARG4_NA 0x0
#define MCIF_ASCII_FLAGS_ARG5_NA 0x0
#define MCIF_ASCII_FLAGS_ARG6_NA 0x0
 
#define MCIF_ASCII_FLAGS_ARG1_INT 0x1
#define MCIF_ASCII_FLAGS_ARG2_INT 0x4
#define MCIF_ASCII_FLAGS_ARG3_INT 0x10
#define MCIF_ASCII_FLAGS_ARG4_INT 0x40
#define MCIF_ASCII_FLAGS_ARG5_INT 0x100
#define MCIF_ASCII_FLAGS_ARG6_INT 0x400
 
#define MCIF_ASCII_FLAGS_ARG1_STR 0x2
#define MCIF_ASCII_FLAGS_ARG2_STR 0x8
#define MCIF_ASCII_FLAGS_ARG3_STR 0x20
#define MCIF_ASCII_FLAGS_ARG4_STR 0x80
#define MCIF_ASCII_FLAGS_ARG5_STR 0x200
#define MCIF_ASCII_FLAGS_ARG6_STR 0x800
 
#define MCIF_ASCII_FLAGS_ARG1_STR_NO_WHITE 0x3
#define MCIF_ASCII_FLAGS_ARG2_STR_NO_WHITE 0xc
#define MCIF_ASCII_FLAGS_ARG3_STR_NO_WHITE 0x30
#define MCIF_ASCII_FLAGS_ARG4_STR_NO_WHITE 0xc0
#define MCIF_ASCII_FLAGS_ARG5_STR_NO_WHITE 0x300
#define MCIF_ASCII_FLAGS_ARG6_STR_NO_WHITE 0xc00
 
#if MCIF_MAX_ARGS < 4
#define MCIF_ASCII_FLAGS_AUTO_REPLY 0x80
#else
#define MCIF_ASCII_FLAGS_AUTO_REPLY 0x8000
#endif
 
#if MCIF_MAX_ARGS > 2
typedef void (*cmd_cb_t)(xQueueHandle txq, void **args);
#else
typedef void (*cmd_cb_t)(xQueueHandle txq, void *arg1, void *arg2);
#endif
 
struct mcif_ascii_parse_element_s
{
        const char *name; 
#if MCIF_MAX_ARGS > 2
        void (*fn)(xQueueHandle txq, void **args); 
#else
        void (*fn)(xQueueHandle txq, void *arg1, void *arg2); 
#endif
        const char *help_str; 
#if MCIF_MAX_ARGS < 4
        uint8_t flags; 
#else
        uint16_t flags; 
#endif
};
 
void mcif_ascii_parse_message(
        const struct mcif_ascii_parse_element_s *parse_table,
        xQueueHandle txq,
        struct mcif_message_s *msg);
 
void mcif_ascii_print_prompt(
        const struct mcif_ascii_parse_element_s *parse_table,
        xQueueHandle txq,
        struct mcif_message_s *msg) __WEAK;
 
void mcif_ascii_print_unknown(
        const struct mcif_ascii_parse_element_s *parse_table,
        xQueueHandle txq,
        struct mcif_message_s *msg) __WEAK;
 
void mcif_ascii_send_response(const struct mcif_ascii_parse_element_s *parse_table,
        xQueueHandle txq,
        struct mcif_message_s *msg, bool show_prompt);
 
void mcif_setup_queues(int cli_id, OS_QUEUE txq, OS_QUEUE rxq);
 
 
#if MCIF_USE_TASK_NOTIFICATIONS == 1
 
void mcif_setup_client_notifications(int cli_id, OS_TASK handle, uint8_t notif_bit);
#endif
 
OS_BASE_TYPE mcif_queue_send(int cli_id, const void *item,
        OS_TICK_TIME wait_ticks);
 
void mcif_init(void);
 
#endif /* MCIF_H */