m2mb_os_q.h

Go to the documentation of this file.

/* $version: 301934  */ 
/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef M2MB_OS_Q_H
#define M2MB_OS_Q_H

#ifdef __cplusplus
extern "C" {
#endif

/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/


/* Global declarations ==========================================================================*/
#define  M2MB_OS_Q_INVALID           0
#define  M2MB_OS_Q_INVALID_ATTR      0
#define  M2MB_OS_Q_TX_PRIORITIZE     1

/* used to get how many word32 are needed for specified "type" struct : see M2MB_OS_Q_SEL_CMD_MSG_SIZE */
#define WORD32_FOR_MSG( type )     ( ( sizeof( type ) % 4 ) == 0 ? sizeof( type ) / 4 : sizeof( type ) / 4 + 1 )
/* then for decide how many bytes to reserve for any message in the queue : see M2MB_OS_Q_SEL_CMD_QSIZE */
#define BYTES_FOR_MSG( type )       ( 4 * WORD32_FOR_MSG( type ) )

/*-----------------------------------------------------------------------------------------------

    can be called directly without specify CMDS_ARGS
    osRes = m2mb_os_q_setAttrItem_( &qAttrHandle,
                                    M2MB_OS_Q_SEL_CMD_CREATE_ATTR, NULL,
                                    M2MB_OS_Q_SEL_CMD_NAME, "Myqueue_T",
                                    M2MB_OS_Q_SEL_CMD_QSTART, &QueueArea,
                                    M2MB_OS_Q_SEL_CMD_MSG_SIZE, WORD32_FOR_MSG( MY_MSG_T ),
                                    M2MB_OS_Q_SEL_CMD_QSIZE, sizeof(QueueArea)
                                  );
  -----------------------------------------------------------------------------------------------*/
#define m2mb_os_q_setAttrItem_( h, args,... )        m2mb_os_q_setAttrItem( h, CMDS_ARGS( args ) )

/* Global typedefs --------------------------------------------------------------- */

typedef enum
{
  M2MB_OS_Q_SEL_CMD_CREATE_ATTR,
  M2MB_OS_Q_SEL_CMD_DEL_ATTR,
  /* use as Os name: only available for creation */
  M2MB_OS_Q_SEL_CMD_NAME,
  /* if set, usr name could be different from Os used in creation  */
  M2MB_OS_Q_SEL_CMD_USRNAME,
  /* size of message in 32 bit words: 1 to 16 max */
  M2MB_OS_Q_SEL_CMD_MSG_SIZE,
  /* if not specified will be allocated by system: if specified align to MEM_W
     to avoid possible loosing space for 1 message
  */
  M2MB_OS_Q_SEL_CMD_QSTART,
  /* size in byte */
  M2MB_OS_Q_SEL_CMD_QSIZE,
  /* number of task suspended on the queue */
  M2MB_OS_Q_SEL_CMD_SUSPENDED_COUNT,
  /* first task (M2MB_OS_TASK_HANDLE) to be served when msg will be enqueued */
  M2MB_OS_Q_SEL_CMD_1ST_SUSP,
  /* number of messages enqueued on the queue*/
  M2MB_OS_Q_SEL_CMD_ENQUEUED,
  /* number of messages the queue currently has space for */
  M2MB_OS_Q_SEL_CMD_QROOM,

  /* ---- */
  M2MB_OS_Q_SEL_CMD_END,
  ENUM_TO_INT( M2MB_OS_Q_SEL_CMD_E )
} M2MB_OS_Q_SEL_CMD_E;


typedef struct M2MB_OS_Q_HANDLE_TAG      *M2MB_OS_Q_HANDLE;
typedef struct M2MB_OS_Q_ATTR_HANDLE_TAG *M2MB_OS_Q_ATTR_HANDLE;

/* Global functions =============================================================================*/

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_q_init( M2MB_OS_Q_HANDLE *pQHandle, M2MB_OS_Q_ATTR_HANDLE *pQAttrHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_q_deinit( M2MB_OS_Q_HANDLE qHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_q_rx( M2MB_OS_Q_HANDLE qHandle, void *pDest, UINT32 timeoutTicks );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_q_tx(
  M2MB_OS_Q_HANDLE qHandle,
  void *pSource,
  UINT32 timeoutTicks,
  UINT8 priority
);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_q_hptf( M2MB_OS_Q_HANDLE queueHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_q_clear( M2MB_OS_Q_HANDLE qHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_q_setAttrItem( M2MB_OS_Q_ATTR_HANDLE *pQAttrHandle, UINT8 nCmds, ... );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_q_getItem(
  M2MB_OS_Q_HANDLE qHandle,
  M2MB_OS_Q_SEL_CMD_E selCmd,
  MEM_W *pOut,
  void *pIn
);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_q_setItem(
  M2MB_OS_Q_HANDLE qHandle,
  M2MB_OS_Q_SEL_CMD_E selCmd,
  void *pIn
);


#ifdef __cplusplus
}
#endif

#endif /* M2MB_OS_H */