m2mb_app_framework.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef   __M2MB_APP_FRAMEWORK_H
#define   __M2MB_APP_FRAMEWORK_H

/*-----------------------------------------------------------------------------------------------*/
/* Global declarations ==========================================================================*/

/* Global typedefs ==============================================================================*/

#define M2MB_AF_MAX_USER_THREAD_SUPPORTED 10
#define TEST_START      "\r\nEXAMPLE APPLICATION TEST START\r\n"
#define TEST_COMPLETE   "\r\nEXAMPLE APPLICATION TEST COMPLETE\r\n"
#define TEST_COMPLETE_COUNT 5

typedef enum M2MB_AF_NWK_EVENT
{
    M2MB_AF_NWK_DATA_RECEVEID = 1,
    M2MB_AF_NWK_CONNECTION_CLOSE,
    M2MB_AF_NWK_NEW_CONNECTION
}M2MB_AF_NWK_EVENT_E;

typedef enum M2MB_AF_DRV_TYPE
{
    M2MB_AF_DRV_TYPE_UART0,
    M2MB_AF_DRV_TYPE_UART1
}M2MB_AF_DRV_TYPE_E;


typedef VOID (*M2MB_AF_INIT_CB_T)( VOID *user_ctx,
                                   M2MB_PROFILE_EVENT_T event,
                                   M2MB_STATUS_T status,
                                   VOID* pData);

typedef VOID (*M2MB_AF_DRV_RD_CB_T)( VOID *user_ctx,
                                     M2MB_AF_DRV_TYPE_E module_type, 
                                     VOID* pData,
                                     UINT32 len);

typedef struct M2MB_AF_NWK_DATA_RECV
{
    UINT8* pBuf;
    UINT32 len;
    M2MB_SOCKET_BSD_SOCKADDR_IN_T* from;
}M2MB_AF_NWK_DATA_RECV_T;

typedef VOID (*M2MB_AF_NWK_EV_CB_T)( VOID *user_ctx,
                                     UINT32 sd, 
                                     M2MB_AF_NWK_EVENT_E ev,
                                     VOID* pData );

typedef struct M2MB_AF_APP_THREAD_S
{
    M2MB_OS_TASK_HANDLE thrHandle;
    UINT8 *thread_stack;
    M2MB_OS_Q_HANDLE pQHandle;
    VOID *QMsg_space;
}M2MB_AF_APP_THREAD_T;

typedef VOID (*M2MB_AF_THREAD_PROCESS_T)( VOID *user_ctx, 
                                          M2MB_AF_APP_THREAD_T *pTCtx,
                                          VOID* pMsg );

typedef struct M2M_AF_USER_THREAD_DETAILS_S
{
    UINT8*                   thread_name;
    UINT32                   stack_size; 
    UINT8                    priority;    
    UINT8                    q_msg_size;
    UINT8                    q_size;
    VOID*                    user_ctx;
    M2MB_AF_THREAD_PROCESS_T process_api;
} M2M_AF_USER_THREAD_DETAILS_T;

typedef struct M2M_AF_USER_THREAD_CFG_S
{
    UINT8 num_of_thread;
    M2M_AF_USER_THREAD_DETAILS_T cfg[1];
} M2M_AF_USER_THREAD_CFG_T;

typedef struct M2MB_AF_USER_CFG_S
{ 
    M2M_AF_USER_THREAD_CFG_T thread;
    VOID *pUsr_ctx;
    M2MB_AF_INIT_CB_T   init;
    M2MB_AF_DRV_RD_CB_T drv_rd;
    M2MB_AF_NWK_EV_CB_T nwk_cb;
} M2MB_AF_USER_CFG_T;

/* Global functions ============================================================== */
/*-------------------------------------------------------------------------------- */
/* ------------------------------------------------------------------------------ */
VOID m2mb_af_dbg_print(M2MB_SYSTEM_CFG_T * pSystemCfg);

/* ------------------------------------------------------------------------------ */
/* ------------------------------------------------------------------------------- */
INT32 m2mb_af_udp_soc_init(M2MB_UDP_CFG_T *udp_cfg);

/* ------------------------------------------------------------------------------- */
/* ------------------------------------------------------------------------------- */
INT32 m2mb_af_tcp_soc_init(M2MB_T_CFG_T *tcp_cfg);

/* ------------------------------------------------------------------------------- */
/* ------------------------------------------------------------------------------- */
INT32 m2mb_af_start( M2MB_AF_USER_CFG_T *pApp_cfg, const M2MB_SYSTEM_CFG_T *pSystem_cfg );

/* ------------------------------------------------------------------------------- */
#endif  /*  __M2MB_APP_FRAMEWORK_H */