Mailbox.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022, Texas Instruments Incorporated - http://www.ti.com
 * 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_sysbios_knl_Mailbox__include
#define ti_sysbios_knl_Mailbox__include

/* BIOS 6.x compatibility, use -Dxdc_std__include to disable */
#include <xdc/std.h>
#include <ti/sysbios/knl/Event.h>
#include <ti/sysbios/knl/Queue.h>
#include <ti/sysbios/knl/Semaphore.h>

#include <ti/sysbios/runtime/Error.h>

/* @cond NODOC */
#define ti_sysbios_knl_Mailbox_long_names
#include "Mailbox_defs.h"
#ifdef __cplusplus
extern "C" {
#endif

#define Mailbox_A_invalidBufSize "Mailbox_create's bufSize parameter is invalid (too small)"

struct Mailbox_MbxElem {
    Queue_Elem elem;
};

typedef struct Mailbox_MbxElem Mailbox_MbxElem;

#define Mailbox_maxTypeAlign (sizeof (long long))

struct Mailbox_Params {
    IHeap_Handle heap;
    Event_Handle readerEvent;
    unsigned int readerEventId;
    Event_Handle writerEvent;
    unsigned int writerEventId;
    void * buf;
    unsigned int bufSize;
};
typedef struct Mailbox_Params Mailbox_Params;

/* Struct */
struct Mailbox_Struct {
    Queue_Elem objElem;
    IHeap_Handle heap;
    size_t msgSize;
    unsigned int numMsgs;
    void * buf;
    unsigned int numFreeMsgs;
    void * allocBuf;
    Queue_Struct dataQue;
    Queue_Struct freeQue;
    Semaphore_Struct dataSem;
    Semaphore_Struct freeSem;
};
typedef struct Mailbox_Struct Mailbox_Object;
typedef struct Mailbox_Struct Mailbox_Struct;
typedef struct Mailbox_Struct *Mailbox_Handle;

typedef struct {
    Queue_Struct objQ;
} Mailbox_Module_State;
extern Mailbox_Handle Mailbox_create(size_t msgSize, unsigned int numMsgs, const Mailbox_Params *prms, Error_Block *eb);

extern Mailbox_Handle Mailbox_construct(Mailbox_Struct *obj, size_t msgSize, unsigned int numMsgs, const Mailbox_Params *prms, Error_Block *eb);

extern void Mailbox_delete(Mailbox_Handle *mailbox);

extern void Mailbox_destruct(Mailbox_Struct *obj);

extern size_t Mailbox_getMsgSize(Mailbox_Handle mailbox);

extern int Mailbox_getNumFreeMsgs(Mailbox_Handle mailbox);

extern int Mailbox_getNumPendingMsgs(Mailbox_Handle mailbox);

extern bool Mailbox_pend(Mailbox_Handle mailbox, void * msg, uint32_t timeout);

extern bool Mailbox_peek(Mailbox_Handle mailbox, void * msg, uint32_t timeout);

extern bool Mailbox_post(Mailbox_Handle mailbox, void * msg, uint32_t timeout);

extern bool Mailbox_putHead(Mailbox_Handle mailbox, void * msg, uint32_t timeout);

extern void Mailbox_Params_init(Mailbox_Params *prms);

extern Mailbox_Handle Mailbox_Object_first(void);

extern Mailbox_Handle Mailbox_Object_next(Mailbox_Handle mbx);

static inline Mailbox_Handle Mailbox_handle(Mailbox_Struct *str)
{
    return ((Mailbox_Handle)str);
}

static inline Mailbox_Struct * Mailbox_struct(Mailbox_Handle h)
{
    return ((Mailbox_Struct *)h);
}

#define Mailbox_module ((Mailbox_Module_State *) &(Mailbox_Module_state))

#ifdef __cplusplus
}
#endif

#endif /* ti_sysbios_knl_Mailbox__include */

/* @cond NODOC */
#undef ti_sysbios_knl_Mailbox_long_names
#include "Mailbox_defs.h"