MotorWare f2806x Module API Documentation
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
queue.h File Reference

Contains the public interface to the event queue (QUEUE) module routines. More...

#include "sw/modules/types/src/types.h"
#include "sw/modules/iqmath/src/32b/IQmathLib.h"
#include "sw/drivers/cpu/src/32b/f28x/f2803x/cpu.h"

Go to the source code of this file.

Data Structures

struct  _EVENT_ArgList_
 Defines the event argument list. More...
 
struct  _EVENT_Obj_
 Defines the event queue object. More...
 
struct  _QUEUE_Obj_
 Defines the queue object structure. More...
 

Macros

#define EVENT_MAX_NUM_ARGS   4
 Defines the maximum number of event arguments. More...
 
#define QUEUE_MAX_NUM_EVENTS   8
 Defines the maximum number of events per queue Note: must be a power of 2. More...
 

Typedefs

typedef void(* EVENT_Fxn) ()
 Defines the event function prototype. More...
 
typedef struct _EVENT_ArgList_ EVENT_ArgList
 Defines the event argument list. More...
 
typedef struct _EVENT_Obj_ EVENT_Obj
 Defines the event queue object. More...
 
typedef struct _EVENT_Obj_EVENT_Handle
 Defines the EVENT handle. More...
 
typedef struct _QUEUE_Obj_ QUEUE_Obj
 Defines the queue object structure. More...
 
typedef struct _QUEUE_Obj_QUEUE_Handle
 Defines the queue handle. More...
 

Enumerations

enum  QUEUE_Status_e { QUEUE_STATUS_FIRST_EVENT_TAKEN =0, QUEUE_STATUS_LAST_EVENT_TAKEN }
 Defines the queue status messages. More...
 

Functions

static bool QUEUE_isEvent (QUEUE_Handle handle)
 Checks if there is an event available in the queue. More...
 
static bool QUEUE_isIdle (QUEUE_Handle handle)
 Checks if the specified queue is idle. More...
 
QUEUE_Handle QUEUE_init (void *pMemory, const size_t numBytes)
 Initializes the queue. More...
 
void QUEUE_listen (QUEUE_Handle handle)
 Puts the calling process in a listen state. It loops until. More...
 
static status QUEUE_postEventFirst (QUEUE_Handle handle, const EVENT_Fxn eventFxn, const EVENT_ArgList *pArgList, const uint_least8_t numArgs)
 Posts an event to the beginning of the specified queue. More...
 
static status QUEUE_postEventLast (QUEUE_Handle handle, const EVENT_Fxn eventFxn, const EVENT_ArgList *pArgList, const uint_least8_t numArgs)
 Posts an event to the end of the specified queue. More...
 
static void QUEUE_removeFirstEvent (QUEUE_Handle handle)
 Removed the first event from the specified queue. More...
 
static void QUEUE_removeLastEvent (QUEUE_Handle handle)
 Removed the last event from the specified queue. More...
 
static void QUEUE_executeEvent (QUEUE_Handle handle)
 Checks the specified event queue for an event. If there is an event,. More...
 

Variables

uint32_t gEventIndex
 The event index. More...
 
EVENT_Obj gEvents [QUEUE_MAX_NUM_EVENTS]
 The array of events. More...
 

Detailed Description

Contains the public interface to the event queue (QUEUE) module routines.

(C) Copyright 2011, Texas Instruments, Inc.

Definition in file queue.h.