include/microkernel/command_packet.h

/* command_packet.h - 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.
 */

/**
 * @brief Microkernel command packet library
 *
 * A command packet is an opaque data structure that maps to a k_args without
 * exposing its innards. It allows a subsystem, like a driver, that needs its
 * fibers or ISRs to communicate with tasks to define a set of such packets to
 * be passed to the isr_xxx routines, such as isr_sem_give(), that, in turn,
 * needs to obtain command packets to interact with the microkernel.
 *
 * Each command packet set is created in global memory using ...
 *   CMD_PKT_SET_INSTANCE(set variable name, # of command packets in the set);
 *
 * Once created, the command packet set is accessed using ...
 *   CMD_PKT_SET(set variable name).<member field name>

 * A command packet set is a simple ring buffer.  No error checking is performed
 * when a command packet is retrieved from the set.  Each obtained command packet
 * is implicitly released once the command packet has been processed.  Thus, it is
 * important that each command packet be processed in a near-FIFO order to prevent
 * corruption of command packets that are already in use.  To this end, drivers
 * that have an ISR component should use their own command packet set.
 */

#ifndef _COMMAND_PACKET_H
#define _COMMAND_PACKET_H

#ifdef __cplusplus
extern "C" {
#endif

#include <microkernel/base_api.h>

/* define size of command packet (without exposing its internal structure) */

#define CMD_PKT_SIZE_IN_WORDS (19)

/**
 * @brief Define a command packet set
 *
 *
 * This macro is used to create a command packet set in the global namespace.
 * Each packet set can have a different number of packets.
 *
 * @param name Name of command packet set
 * @param num Number of packets in the set
 *
 * @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.
 * @endinternal
 */
#define CMD_PKT_SET_INSTANCE(name, num) \
	uint32_t name[2 + CMD_PKT_SIZE_IN_WORDS * (num)] = {num, 0}

/**
 * @brief Wrapper for accessing a command packet set
 *
 * A command packet set must be typecast to the cmd_pkt_set type
 * when accessed, because it is instantiated as an array of uint32_t.
 *
 * @param name Name of command packet set
 *
 */
#define CMD_PKT_SET(name) (*(struct cmd_pkt_set *)(name))

typedef uint32_t cmdPkt_t[CMD_PKT_SIZE_IN_WORDS];

struct cmd_pkt_set {
	uint32_t num_packets;    /* number of command packets in set */
	uint32_t index;    /* index into command packet array */
	cmdPkt_t command_packet[]; /* array of command packets */
};

/* externs */

extern cmdPkt_t *_cmd_pkt_get(struct cmd_pkt_set *pSet);

#ifdef __cplusplus
}
#endif

#endif /* _COMMAND_PACKET_H */