ipc_msg.h

Go to the documentation of this file.

/*
 * @brief LPC43XX Inter Processor Communication(IPC) functions
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
 * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#ifndef __IPC_MSG_H_
#define __IPC_MSG_H_

#ifdef __cplusplus
extern "C" {
#endif

/* Queue status macro */
#define QUEUE_DATA_COUNT(q) ((uint32_t) ((q)->head - (q)->tail))

#define QUEUE_IS_FULL(q)    (QUEUE_DATA_COUNT(q) >= (q)->count)

#define QUEUE_IS_EMPTY(q)   ((q)->head == (q)->tail)

#define QUEUE_IS_VALID(q)   ((q)->valid == QUEUE_MAGIC_VALID)

struct ipc_queue {
 int32_t size;    
 int32_t count;    
 volatile uint32_t head;  
 volatile uint32_t tail;  
 uint8_t *data;    
 uint32_t valid;             
 uint32_t reserved[2];  
};

/* IPC Function return values */
#define QUEUE_VALID      1

#define QUEUE_INSERT     0

#define QUEUE_FULL      -1

#define QUEUE_EMPTY     -2

#define QUEUE_ERROR     -3

#define QUEUE_TIMEOUT   -4

#define QUEUE_MAGIC_VALID   0xCAB51053

int IPC_pushMsgTout(const void *data, int tout);

int IPC_popMsgTout(void *data, int tout);

static INLINE int IPC_tryPushMsg(const void *data)
{
 return IPC_pushMsgTout(data, 0);
}

static INLINE int IPC_tryPopMsg(void *data)
{
 return IPC_popMsgTout(data, 0);
}

static INLINE int IPC_pushMsg(const void *data)
{
 return IPC_pushMsgTout(data, -1);
}

static INLINE int IPC_popMsg(void *data)
{
 return IPC_popMsgTout(data, -1);
}

int IPC_msgPending(int queue_write);

void IPC_msgNotify(void);

void IPC_initMsgQueue(void *data, int msgSize, int maxNoOfMsg);

const char *IPC_strerror(int errnum);

#ifdef __cplusplus
}
#endif

#endif /* ifndef __IPC_MSG_H_ */