MessageQueueP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023, 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_dpl_MessageQueueP__include
#define ti_dpl_MessageQueueP__include

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include <ti/devices/DeviceFamily.h>

#ifdef __cplusplus
extern "C" {
#endif

#define MessageQueueP_STRUCT_SIZE (104)

#if ((DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X0_CC26X0) ||        \
     (DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X2_CC26X2) ||        \
     (DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X1_CC26X1) ||        \
     (DeviceFamily_PARENT == DeviceFamily_PARENT_CC13X4_CC26X3_CC26X4) || \
     (DeviceFamily_PARENT == DeviceFamily_PARENT_CC32XX))
    #define MessageQueueP_BUFFER_SIZE(msgSize, msgCount) ((msgCount) * ((msgSize) + 8))
#else
    #define MessageQueueP_BUFFER_SIZE(msgSize, msgCount) ((msgCount) * (msgSize))
#endif

typedef union MessageQueueP_Struct
{
    uint32_t dummy; 
    uint8_t data[MessageQueueP_STRUCT_SIZE];
} MessageQueueP_Struct;

#define MessageQueueP_WAIT_FOREVER ~(0)

#define MessageQueueP_NO_WAIT (0)

typedef enum
{
    MessageQueueP_OK      = 0,
    MessageQueueP_TIMEOUT = -1
} MessageQueueP_Status;

typedef void *MessageQueueP_Handle;

extern MessageQueueP_Handle MessageQueueP_create(size_t msgSize, size_t msgCount);

MessageQueueP_Handle MessageQueueP_construct(MessageQueueP_Struct *queueStruct,
                                             size_t msgSize,
                                             size_t msgCount,
                                             void *msgBuf);

extern void MessageQueueP_delete(MessageQueueP_Handle handle);

extern void MessageQueueP_destruct(MessageQueueP_Handle handle);

extern MessageQueueP_Status MessageQueueP_pend(MessageQueueP_Handle handle, void *message, uint32_t timeout);

extern MessageQueueP_Status MessageQueueP_peek(MessageQueueP_Handle handle, void *message, uint32_t timeout);

extern MessageQueueP_Status MessageQueueP_post(MessageQueueP_Handle handle, const void *message, uint32_t timeout);

extern MessageQueueP_Status MessageQueueP_postFront(MessageQueueP_Handle handle, const void *message, uint32_t timeout);

extern size_t MessageQueueP_getPendingCount(MessageQueueP_Handle handle);

extern size_t MessageQueueP_getFreeCount(MessageQueueP_Handle handle);

#ifdef __cplusplus
}
#endif

#endif /* ti_dpl_MessageQueueP__include */