mailbox.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com/
 *
 *  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      MAILBOX_H_
#define      MAILBOX_H_

#ifdef __cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include "ti/csl/hw_types.h"
#include "ti/csl/cslr_mailbox.h"

/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
/*
 * \name  User Id's Corresponds to the Core using the mailbox
 *        Mailbox Queue's Corresponds to the Mailbox Queue Number
 *  @{
 */
#define MAILBOX_QUEUE_0         0U

#define MAILBOX_QUEUE_1         1U

#define MAILBOX_QUEUE_2         2U

#define MAILBOX_QUEUE_3         3U

#define MAILBOX_QUEUE_4         4U

#define MAILBOX_QUEUE_5         5U

#define MAILBOX_QUEUE_6         6U

#define MAILBOX_QUEUE_7         7U

#define MAILBOX_QUEUE_8         8U

#define MAILBOX_QUEUE_9         9U

#define MAILBOX_QUEUE_10        10U

#define MAILBOX_QUEUE_11        11U

#define MAILBOX_QUEUE_12        12U

#define MAILBOX_QUEUE_13        13U

#define MAILBOX_QUEUE_14        14U

#define MAILBOX_QUEUE_15        15U
/* Incase of SOC_AM65XX, there are 64 queues; macros not provided for simplicity */
/* @} */

/*
 * \name Values that can be returned by MailboxGetMessage/MailboxSendMessage
 * to notify whether the message received/send is valid
 * @{
 */
#define MESSAGE_VALID           0U

#define MESSAGE_INVALID         1U
/* @} */

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

/*  Queue Access API's  */
void MailboxReset(uintptr_t baseAddr);

void MailboxConfigIdleMode(uintptr_t baseAddr, uint32_t idleMode);

uint32_t MailboxGetMessage(uintptr_t baseAddr, uint32_t queueId,
                           uint32_t *msgPtr);

uint32_t MailboxSendMessage(uintptr_t baseAddr, uint32_t queueId, uint32_t msg);

/*  Mailbox user(HW using mailbox) access API's */
void MailboxEnableNewMsgInt(uintptr_t baseAddr, uint32_t userId,
                            uint32_t queueId);

void MailboxEnableQueueNotFullInt(uintptr_t baseAddr, uint32_t userId,
                                  uint32_t queueId);

void MailboxDisableNewMsgInt(uintptr_t baseAddr, uint32_t userId,
                             uint32_t queueId);

void MailboxDisableQueueNotFullInt(uintptr_t baseAddr, uint32_t userId,
                                   uint32_t queueId);

void MailboxClrNewMsgStatus(uintptr_t baseAddr, uint32_t userId,
                            uint32_t queueId);

void MailboxClrQueueNotFullStatus(uintptr_t baseAddr, uint32_t userId,
                                  uint32_t queueId);

uint32_t MailboxGetRawNewMsgStatus(uintptr_t baseAddr, uint32_t userId,
                                   uint32_t queueId);

uint32_t MailboxGetRawQueueNotFullStatus(uintptr_t baseAddr, uint32_t userId,
                                         uint32_t queueId);

uint32_t MailboxGetIrqEnableStatus(uintptr_t baseAddr, uint32_t userId,
                                   uint32_t queueId);
uint32_t MailboxGetMessageCount(uintptr_t baseAddr, uint32_t queueId);

void MailboxWriteMessage(uintptr_t baseAddr, uint32_t queueId, uint32_t msg);

void MailboxWriteEOI(uintptr_t baseAddr, uint32_t value);

void MailboxReadMessage(uintptr_t baseAddr, uint32_t queueId,
                        uint32_t *msgPtr);

#ifdef __cplusplus
}
#endif
#endif

/********************************* End of file ******************************/