m2mb_os_mtx.h

Go to the documentation of this file.

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

#ifdef __cplusplus
extern "C" {
#endif

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

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


/* GLOBAL DECLARATIONS ----------------------------------------------------------- */
#define  M2MB_OS_MTX_INVALID          0
#define  M2MB_OS_MTX_INVALID_ATTR     0

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

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

    can be called directly without specify CMDS_ARGS
    osRes = m2mb_os_mtx_setAttrItem_( &mtxAttrHandle,
                                      M2MB_OS_MTX_SEL_CMD_CREATE_ATTR, NULL,
                                      M2MB_OS_MTX_SEL_CMD_NAME, "myMtx1",
                                      M2MB_OS_MTX_SEL_CMD_USRNAME, "myUserMtx1",
                                      M2MB_OS_MTX_SEL_CMD_INHERIT, inheritVal
                                    );
  -----------------------------------------------------------------------------------------------*/
#define m2mb_os_mtx_setAttrItem_( h, args,... )        m2mb_os_mtx_setAttrItem( h, CMDS_ARGS( args ) )

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

typedef enum
{
  M2MB_OS_MTX_SEL_CMD_CREATE_ATTR,
  M2MB_OS_MTX_SEL_CMD_DEL_ATTR,
  /* use as Os name during creation */
  M2MB_OS_MTX_SEL_CMD_NAME,
  /* if set, usr name could be different from Os during creation */
  M2MB_OS_MTX_SEL_CMD_USRNAME,
  /* select if priority inheritance will be active for it. To avoid priority inversion, priority of the task
     owning the mutex will be temporarily raised to the task of the highest priority waiting for the mutex */
  M2MB_OS_MTX_SEL_CMD_INHERIT,
  /* high priority task first option cmd not supported: here only for backward compatibility
     see function tx_hptf_com(...) for the desired functionality */
  M2MB_OS_MTX_SEL_CMD_HPTF_NO_SUPPORT,
  M2MB_OS_MTX_SEL_CMD_COUNT,
  /* number of task suspended on this resource */
  M2MB_OS_MTX_SEL_CMD_SUSPENDED_COUNT,
  /* first task (M2MB_OS_TASK_HANDLE) to be served when resource will be available */
  M2MB_OS_MTX_SEL_CMD_1ST_SUSP,
  /* owner (M2MB_OS_TASK_HANDLE) of the resource mtxHandle */
  M2MB_OS_MTX_SEL_CMD_OWNER,

  /* ---- */
  M2MB_OS_MTX_SEL_CMD_END,
  ENUM_TO_INT( M2MB_OS_MTX_SEL_CMD_E )
} M2MB_OS_MTX_SEL_CMD_E;

typedef struct M2MB_OS_MTX_HANDLE_TAG      * M2MB_OS_MTX_HANDLE;
typedef struct M2MB_OS_MTX_ATTR_HANDLE_TAG * M2MB_OS_MTX_ATTR_HANDLE;



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

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_mtx_init(
  M2MB_OS_MTX_HANDLE *pMtxHandle,
  M2MB_OS_MTX_ATTR_HANDLE *pMtxAttr
);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_mtx_deinit( M2MB_OS_MTX_HANDLE mtxHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_mtx_get( M2MB_OS_MTX_HANDLE mtxHandle, UINT32 timeoutTicks );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_mtx_put( M2MB_OS_MTX_HANDLE mtxHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_mtx_hptf( M2MB_OS_MTX_HANDLE mtxHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_mtx_setAttrItem(
  M2MB_OS_MTX_ATTR_HANDLE *pMtxAttrHandle,
  UINT8 nCmds,
  ...
);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_mtx_getItem(
  M2MB_OS_MTX_HANDLE mtxHandle,
  M2MB_OS_MTX_SEL_CMD_E selCmd,
  MEM_W *pOut,
  void *pIn
);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
  M2MB_OS_RESULT_E m2mb_os_mtx_setItem( M2MB_OS_MTX_HANDLE mtxHandle,
                                      M2MB_OS_MTX_SEL_CMD_E selCmd,
                                      void *pIn
                                    );


#ifdef __cplusplus
}
#endif

#endif /* M2MB_OS_MTX_H */