MotorWare f2806x Module API Documentation

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

queue.c
Go to the documentation of this file.
1 /* --COPYRIGHT--,BSD
2 * Copyright (c) 2012, Texas Instruments Incorporated
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 * --/COPYRIGHT--*/
37
38
39 // **************************************************************************
40 // the includes
41
42 #include "sw/modules/queue/src/queue.h"
43
44
45 // needed for memset()
46 #include "string.h"
47
48
49 // **************************************************************************
50 // the globals
51
52 uint32_t gEventIndex;
53
54 EVENT_Obj gEvents[QUEUE_MAX_NUM_EVENTS];
55
56
57 // **************************************************************************
58 // the functions
59
60 QUEUE_Handle QUEUE_init(void *pMemory,const size_t numBytes)
61 {
62 QUEUE_Handle handle;
63 QUEUE_Obj *obj;
64
65
66 if(numBytes < sizeof(QUEUE_Obj))
67 return((QUEUE_Handle)NULL);
68
69
70 // assign the handle
71 handle = (QUEUE_Handle)pMemory;
72
73
74 // assign the object
75 obj = (QUEUE_Obj *)handle;
76
77
78 // configure the queue
79 obj->firstEvent = (EVENT_Handle)pMemory;
80 obj->lastEvent = (EVENT_Handle)pMemory;
81
82
83 // zero out the events
84 gEventIndex = 0;
85 (void)memset(&gEvents[0],0,sizeof(gEvents));
86
87 return(handle);
88 } // end of QUEUE_init() function
89
90
91 void QUEUE_listen(QUEUE_Handle handle)
92 {
93
94 for(;;)
95 {
96
97 // wait until the specific queue has an event
98 while(QUEUE_isIdle(handle))
99 {
100 // allow some sleep time
101 #ifndef MATLAB_SIMULATION
102 asm(" NOP ");
103 asm(" NOP ");
104 asm(" NOP ");
105 asm(" NOP ");
106 asm(" NOP ");
107 #endif
108 }
109
110
111 // execute event
112 QUEUE_executeEvent(handle);
113 } // end of for() loop
114
115 } // end of QUEUE_listen() function
116
117
118 // end of file
EVENT_Handle
struct _EVENT_Obj_ * EVENT_Handle
Defines the EVENT handle.
Definition: queue.h:113
QUEUE_init
QUEUE_Handle QUEUE_init(void *pMemory, const size_t numBytes)
Initializes the queue.
Definition: queue.c:60
_QUEUE_Obj_::lastEvent
EVENT_Handle lastEvent
the last event in the queue
Definition: queue.h:121
QUEUE_MAX_NUM_EVENTS
#define QUEUE_MAX_NUM_EVENTS
Defines the maximum number of events per queue Note: must be a power of 2.
Definition: queue.h:78
queue.h
Contains the public interface to the event queue (QUEUE) module routines.
_EVENT_Obj_
Defines the event queue object.
Definition: queue.h:99
gEventIndex
uint32_t gEventIndex
The event index.
Definition: queue.c:52
gEvents
EVENT_Obj gEvents[QUEUE_MAX_NUM_EVENTS]
The array of events.
Definition: queue.c:54
QUEUE_Handle
struct _QUEUE_Obj_ * QUEUE_Handle
Defines the queue handle.
Definition: queue.h:136
_QUEUE_Obj_::firstEvent
EVENT_Handle firstEvent
the first event in the queue
Definition: queue.h:120
QUEUE_listen
void QUEUE_listen(QUEUE_Handle handle)
Puts the calling process in a listen state. It loops until.
Definition: queue.c:91
QUEUE_executeEvent
static void QUEUE_executeEvent(QUEUE_Handle handle)
Checks the specified event queue for an event. If there is an event,.
Definition: queue.h:364
QUEUE_isIdle
static bool QUEUE_isIdle(QUEUE_Handle handle)
Checks if the specified queue is idle.
Definition: queue.h:168
_QUEUE_Obj_
Defines the queue object structure.
Definition: queue.h:118