m2mb_os_sem.h

Go to the documentation of this file.

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

#ifdef __cplusplus
extern "C" {
#endif

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

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

/* Global declarations ==========================================================================*/
#define  M2MB_OS_SEM_INVALID          0
#define  M2MB_OS_SEM_INVALID_ATTR     0

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

    can be called directly without specify CMDS_ARGS
    osRes = m2mb_os_sem_setAttrItem_( &semAttrHandle,
                                      M2MB_OS_SEM_SEL_CMD_CREATE_ATTR,  NULL,
                                      M2MB_OS_SEM_SEL_CMD_COUNT, initVal,
                                      M2MB_OS_SEM_SEL_CMD_TYPE, M2MB_OS_SEM_GEN,
                                      M2MB_OS_SEM_SEL_CMD_NAME, "MySem"
                                    );
  -----------------------------------------------------------------------------------------------*/
#define m2mb_os_sem_setAttrItem_( h, args,... )        m2mb_os_sem_setAttrItem( h, CMDS_ARGS( args ) )

/* Global typedefs --------------------------------------------------------------- */
typedef enum
{
  /* not limited counter value: could overflow and restart with 0 */
  M2MB_OS_SEM_GEN,
  /* counter limited to 1 */
  M2MB_OS_SEM_BINARY,
  /* counter limited to defined value */
  M2MB_OS_SEM_COUNTING,

  M2MB_OS_SEM_MAX,
  ENUM_TO_INT( M2MB_OS_SEM_TYPE_E )
} M2MB_OS_SEM_TYPE_E;

typedef enum
{
  M2MB_OS_SEM_SEL_CMD_CREATE_ATTR,
  M2MB_OS_SEM_SEL_CMD_DEL_ATTR,
  /* use as Os name, available during creation */
  M2MB_OS_SEM_SEL_CMD_NAME,
  /* if set, usr name could be different from Os during creation */
  M2MB_OS_SEM_SEL_CMD_USRNAME,
  /* type of semaphore: see M2MB_OS_SEM_TYPE_E */
  M2MB_OS_SEM_SEL_CMD_TYPE,
  /* max counter value has effect for M2MB_OS_SEM_COUNTING type only */
  M2MB_OS_SEM_SEL_CMD_MAX_COUNT,
  /* High Priority Task First: every put will move highest priority task on top of FIFO */
  M2MB_OS_SEM_SEL_CMD_HPTF,
  /* curren semaphore counting value */
  M2MB_OS_SEM_SEL_CMD_COUNT,
  /* number of task suspended on this resource */
  M2MB_OS_SEM_SEL_CMD_SUSPENDED_COUNT,
  /* first task (M2MB_OS_TASK_HANDLE) to be served when resource will be available */
  M2MB_OS_SEM_SEL_CMD_1ST_SUSP,

  /* ---- */
  M2MB_OS_SEM_SEL_CMD_END,
  ENUM_TO_INT( M2MB_OS_SEM_SEL_CMD_E )
} M2MB_OS_SEM_SEL_CMD_E;

typedef struct M2MB_OS_SEM_HANDLE_TAG      *M2MB_OS_SEM_HANDLE;
typedef struct M2MB_OS_SEM_ATTR_HANDLE_TAG *M2MB_OS_SEM_ATTR_HANDLE;


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


/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_sem_init(
  M2MB_OS_SEM_HANDLE *pSemHandle,
  M2MB_OS_SEM_ATTR_HANDLE *pSemAttr
);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_sem_deinit( M2MB_OS_SEM_HANDLE semHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_sem_get( M2MB_OS_SEM_HANDLE semHandle, UINT32 timeoutTicks );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_sem_put( M2MB_OS_SEM_HANDLE semHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_sem_hptf( M2MB_OS_SEM_HANDLE semHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_sem_setAttrItem(
  M2MB_OS_SEM_ATTR_HANDLE *pSemAttrHandle,
  UINT8 nCmds,
  ...
);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_sem_getItem( M2MB_OS_SEM_HANDLE semHandle,
                                      M2MB_OS_SEM_SEL_CMD_E selCmd,
                                      MEM_W *pOut,
                                      void *pIn
                                    );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_sem_setItem(
  M2MB_OS_SEM_HANDLE semHandle,
  M2MB_OS_SEM_SEL_CMD_E selCmd,
  void *pIn
);

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

#ifdef __cplusplus
}
#endif
#endif /* M2MB_OS_SEM_H */