mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-03 01:31:59 +00:00
101d486834
Since multi-node systems are not supported, the 'Srce' field now only serves one purpose--to indicate whether the packet was allocated from the command packet pool. As such, a better name (and type) for it is 'alloc' (of type 'bool') since 'Srce' (of type 'knode_t') suggest multi-node support. Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com> Change-Id: I47a935af13fd55dbca23c879841d68caf895eae4
94 lines
3.2 KiB
C
94 lines
3.2 KiB
C
/* cmdPkt.h - statically allocated command packet header file */
|
|
|
|
/*
|
|
* Copyright (c) 2012-2014 Wind River Systems, Inc.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1) Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
*
|
|
* 2) 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.
|
|
*
|
|
* 3) Neither the name of Wind River Systems 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 HOLDER 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 __INCcmdPkth
|
|
#define __INCcmdPkth
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* includes */
|
|
|
|
#include <microkernel/k_struct.h>
|
|
|
|
/* defines */
|
|
|
|
#define CMD_PKT_SIZE_IN_WORDS (sizeof(struct k_args) / sizeof(uint32_t))
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* CMD_PKT_SET_INSTANCE - define an instance of a command packet set
|
|
*
|
|
* This macro is used to create an instance of a command packet set in the
|
|
* global namespace. Each instance of the set may have its own unique number
|
|
* of command packets.
|
|
*
|
|
* INTERNAL
|
|
* It is critical that the word corresponding to the [alloc] field in the
|
|
* equivalent struct k_args command packet be zero so that the system knows that the
|
|
* command packet is not part of the free list.
|
|
*/
|
|
|
|
#define CMD_PKT_SET_INSTANCE(name, num) \
|
|
uint32_t name[2 + CMD_PKT_SIZE_IN_WORDS * (num)] = {num, 0};
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* CMD_PKT_SET - wrapper for accessing a command packet set
|
|
*
|
|
* As a command packet set is instantiated as an array of uint32_t, it is
|
|
* necessary to typecast a command packet set before accessing it.
|
|
*/
|
|
|
|
#define CMD_PKT_SET(name) (*(struct cmd_pkt_set *)(name))
|
|
|
|
/* typedefs */
|
|
|
|
typedef uint32_t cmdPkt_t[CMD_PKT_SIZE_IN_WORDS];
|
|
|
|
struct cmd_pkt_set {
|
|
uint32_t nPkts; /* number of command packets in set */
|
|
uint32_t index; /* index into command packet array */
|
|
cmdPkt_t cmdPkt[]; /* array of command packets */
|
|
};
|
|
|
|
/* externs */
|
|
|
|
extern cmdPkt_t *cmdPktGet(struct cmd_pkt_set *pSet);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __INCcmdPkth */
|