m2mb_os_ev.h

Go to the documentation of this file.

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


#ifdef __cplusplus
extern "C" {
#endif

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

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


/* GLOBAL DECLARATIONS ----------------------------------------------------------- */
#define  M2MB_OS_EV_INVALID      0
#define  M2MB_OS_EV_INVALID_ATTR 0



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

    can be called directly without specify CMDS_ARGS
    osRes = m2mb_os_ev_setAttrItem_( &evAttrHandle,
                                     M2MB_OS_EV_SEL_CMD_CREATE_ATTR, NULL,
                                     M2MB_OS_EV_SEL_CMD_NAME, "event_1",
                                     M2MB_OS_EV_SEL_CMD_USRNAME, "myevent1"
                                   );
  -----------------------------------------------------------------------------------------------*/
#define m2mb_os_ev_setAttrItem_( h, args,... )        m2mb_os_ev_setAttrItem( h, CMDS_ARGS( args ) )

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

typedef enum
{
  M2MB_OS_EV_SEL_CMD_CREATE_ATTR,
  M2MB_OS_EV_SEL_CMD_DEL_ATTR,
  /* use as Os name , can be used during creation */
  M2MB_OS_EV_SEL_CMD_NAME,
  /* if set, usr name could be different from Os used in creation  */
  M2MB_OS_EV_SEL_CMD_USRNAME,
  /* number of task suspended on this resource */
  M2MB_OS_EV_SEL_CMD_SUSPENDED_COUNT,
  /* first task (M2MB_OS_TASK_HANDLE) to be served when its required resources will be available */
  M2MB_OS_EV_SEL_CMD_1ST_SUSP,
  /* to get the status of current bits event */
  M2MB_OS_EV_SEL_CMD_CURRENT_BITS_EVENT,

  /* ---- */
  M2MB_OS_EV_SEL_CMD_END,
  ENUM_TO_INT( M2MB_OS_EV_SEL_CMD_E )
} M2MB_OS_EV_SEL_CMD_E;

/* options for setting event bits: set or clear specified ones */
typedef enum
{
  M2MB_OS_EV_SET = 0,
  M2MB_OS_EV_CLEAR = 2,

  /* ---- */
  M2MB_OS_EV_SET_OPT_END,
  ENUM_TO_INT( M2MB_OS_EV_SET_OPT_E )
} M2MB_OS_EV_SET_OPT_E;

/* options for getting event bits: get all selected (and clear) or get any of selected (and clear matches) */
typedef enum
{
  /* get the event if any of the selected event bits are set ...*/
  M2MB_OS_EV_GET_ANY = 0,
  /* ... then clear all the set bit in selected event bits  */
  M2MB_OS_EV_GET_ANY_AND_CLEAR,
  /* get the event if all the selected event bits are set ...*/
  M2MB_OS_EV_GET_ALL,
  /* ... then clear all the set bit in selected event bits  */
  M2MB_OS_EV_GET_ALL_AND_CLEAR,

  /* ---- */
  M2MB_OS_EV_GET_OPT_END,
  ENUM_TO_INT( M2MB_OS_EV_GET_OPT_E )
} M2MB_OS_EV_GET_OPT_E;

typedef struct M2MB_OS_EV_HANDLE_TAG      *M2MB_OS_EV_HANDLE;
typedef struct M2MB_OS_EV_ATTR_HANDLE_TAG *M2MB_OS_EV_ATTR_HANDLE;


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

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_ev_init( M2MB_OS_EV_HANDLE *pEvHandle, M2MB_OS_EV_ATTR_HANDLE *pEvAttr );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_ev_deinit( M2MB_OS_EV_HANDLE eveHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_ev_set(
  M2MB_OS_EV_HANDLE evHandle,
  UINT32 evBits,
  M2MB_OS_EV_SET_OPT_E optSet
);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_ev_get(
  M2MB_OS_EV_HANDLE evHandle,
  UINT32 reqEvBits,
  M2MB_OS_EV_GET_OPT_E optGet,
  UINT32 *pCurEvBits,
  UINT32 timeout
);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_ev_setAttrItem( M2MB_OS_EV_ATTR_HANDLE *pEvAttr, UINT8 nCmds, ... );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_ev_getItem(
  M2MB_OS_EV_HANDLE evHandle,
  M2MB_OS_EV_SEL_CMD_E selCmd,
  MEM_W *pOut,
  void *pIn
);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_ev_setItem(
  M2MB_OS_EV_HANDLE evHandle,
  M2MB_OS_EV_SEL_CMD_E selCmd,
  void *pIn
);


#ifdef __cplusplus
}
#endif

#endif /* M2MB_OS_EV_H */