MailboxP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_osal_MailboxP__include
#define ti_osal_MailboxP__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>

typedef enum MailboxP_Status_e
{
    MailboxP_OK         = 0,
    MailboxP_FAILURE    = (-(int32_t)1),
    MailboxP_TIMEOUT    = (-(int32_t)2)
} MailboxP_Status;

#define MailboxP_WAIT_FOREVER (~((uint32_t)0U))

#define MailboxP_NO_WAIT       ((uint32_t)0U)


typedef  void *MailboxP_Handle;

typedef struct MailboxP_Params_s
{
    void *pErrBlk;     
    void *name;        
    uint32_t size;     
    uint32_t count;    
    uint32_t bufsize;  
    void *buf;         
} MailboxP_Params;


extern void MailboxP_Params_init(MailboxP_Params *params);

extern MailboxP_Handle MailboxP_create(const MailboxP_Params *params);

extern MailboxP_Status MailboxP_delete(MailboxP_Handle handle);

extern MailboxP_Status MailboxP_post(MailboxP_Handle handle,
                                     void * msg,
                                     uint32_t timeout);

extern MailboxP_Status MailboxP_pend(MailboxP_Handle handle,
                                     void * msg,
                                     uint32_t timeout);

extern int32_t MailboxP_getNumPendingMsgs(MailboxP_Handle handle);

#ifdef __cplusplus
}
#endif

#endif /* ti_osal_MailboxP__include */
/* @} */