Nrk-api-signals-semaphores

Version 42 (Anthony Rowe, 04/03/2011 07:12 pm)

1 11 Anthony Rowe
= Signals =
2 39 Anthony Rowe
[[TracNav(nrk-api-toc)]]
3 1 Anthony Rowe
A signal is a message that a task can use to wakeup one or more tasks waiting on an
4 1 Anthony Rowe
event or events. When waiting on an event, a task is suspended and does not consume
5 4 Anthony Rowe
CPU time. Nano-RK supports 32 unique signals. It is possible to wait on multiple
6 1 Anthony Rowe
signals such that any one of them can wake a task from sleep. All signals must be
7 6 Anthony Rowe
created using nrk_sig_create() before they can be used.  Any task that wishes to wakeup on a signal
8 6 Anthony Rowe
must register the signal using nrk_sig_register().  There are a few special case signals that are
9 6 Anthony Rowe
generated by the kernel used to support event timeouts and notification of special actions.  See the
10 15 Anthony Rowe
'''Special Kernel Signals''' subsection for more information.  For more information about signals, please refer
11 14 Anthony Rowe
to the basic_signals project that comes with Nano-RK: 
12 41 Anthony Rowe
[http://www.nanork.org/browser/nano-RK/projects/examples/signals basic_signals]
13 1 Anthony Rowe
14 42 Anthony Rowe
Each signal and semaphore requires a system resource.  These are statically defined and must be declared in the nrk_cfg.h file as shown below:
15 42 Anthony Rowe
{{{
16 42 Anthony Rowe
#!c
17 42 Anthony Rowe
#define NRK_MAX_RESOURCE_CNT       5
18 42 Anthony Rowe
}}}
19 11 Anthony Rowe
20 28 Anthony Rowe
'''Signal and Semaphore Types'''
21 28 Anthony Rowe
22 5 Anthony Rowe
{{{
23 5 Anthony Rowe
#!c
24 5 Anthony Rowe
// This is a macro used to convert a signal into a bitmask for nrk_event_wait()
25 5 Anthony Rowe
// See nrk_event_wait() for an example.
26 5 Anthony Rowe
#define SIG(x)  ((uint32_t)1)<<x 
27 5 Anthony Rowe
28 5 Anthony Rowe
// These are typedefs used to represent signals and semaphores
29 5 Anthony Rowe
typedef int8_t nrk_sig_t;
30 5 Anthony Rowe
typedef uint32_t nrk_sig_mask_t;
31 5 Anthony Rowe
typedef int8_t nrk_sem_t;
32 5 Anthony Rowe
}}}
33 5 Anthony Rowe
34 36 Anthony Rowe
=== nrk_signal_create ===
35 36 Anthony Rowe
|| void nrk_signal_create() ||
36 36 Anthony Rowe
|| ''Parameters'': none ||
37 36 Anthony Rowe
|| ''Return Values:'' nrk_sig_t new signal id ||
38 1 Anthony Rowe
39 23 Anthony Rowe
This function creates a signal.  Upon failure, this function returns NRK_ERROR.  Upon success a positive value
40 23 Anthony Rowe
representing the signal is returned.
41 23 Anthony Rowe
42 24 Anthony Rowe
{{{
43 24 Anthony Rowe
  nrk_sig_t signal_one;
44 24 Anthony Rowe
  nrk_sig_t signal_two;
45 24 Anthony Rowe
  ...
46 24 Anthony Rowe
                    
47 24 Anthony Rowe
  signal_one=nrk_signal_create();
48 1 Anthony Rowe
  signal_two=nrk_signal_create();
49 1 Anthony Rowe
}}}
50 1 Anthony Rowe
51 36 Anthony Rowe
=== nrk_signal_delete ===
52 36 Anthony Rowe
|| int8_t nrk_signal_delete(nrk_sig_t sig_id) ||
53 36 Anthony Rowe
|| ''Parameters'': nrk_sig_t signal id of signal to remove ||
54 36 Anthony Rowe
|| ''Return Values:'' int8_t NRK_OK upon success and NRK_ERROR upon failure ||
55 1 Anthony Rowe
56 1 Anthony Rowe
This function deletes a signal ''sig_id'' so that it can be reused by different tasks.  This function returns NRK_OK upon success and NRK_ERROR on failure.
57 1 Anthony Rowe
58 36 Anthony Rowe
=== nrk_event_signal ===
59 36 Anthony Rowe
|| int8_t nrk_event_signal(nrk_sig_t sig_id) ||
60 36 Anthony Rowe
|| ''Parameters'': nrk_sig_t signal id of signal to be sent ||
61 36 Anthony Rowe
|| ''Return Values:'' int8_t NRK_OK upon success and NRK_ERROR upon failure ||
62 1 Anthony Rowe
63 1 Anthony Rowe
This function is used to signal tasks that are waiting on events using nrk_event_wait().
64 23 Anthony Rowe
''sig_id'' is the signal that is sent.  This function returns NRK_OK upon success and NRK_ERROR upon failure.
65 23 Anthony Rowe
If a lower priority task signals a higher priority task, the high priority task will begin to execute at 
66 23 Anthony Rowe
the next context swap.  Normally this happens when the low priority task suspends, but it is also possible
67 23 Anthony Rowe
that a medium priority task could preempt the low priority task causing a context swap that would then
68 23 Anthony Rowe
schedule the waiting high priority task.  For this reason, processing that needs to be complete before the signaled task
69 31 Anthony Rowe
executes should be done before the signals are sent. 
70 29 Anthony Rowe
 * Errno
71 29 Anthony Rowe
  * 1 Signal was not created
72 1 Anthony Rowe
  * 2 No task was waiting on signal
73 24 Anthony Rowe
74 24 Anthony Rowe
{{{
75 1 Anthony Rowe
#!c
76 1 Anthony Rowe
   v=nrk_event_signal( signal_one );
77 1 Anthony Rowe
   if(v==NRK_ERROR) nrk_kprintf( PSTR( "nrk_event_signal failed\r\n" ));
78 1 Anthony Rowe
}}}
79 24 Anthony Rowe
80 36 Anthony Rowe
=== nrk_event_wait ===
81 36 Anthony Rowe
|| nrk_sig_mask_t nrk_event_signal(nrk_sig_mask_t event_mask) ||
82 36 Anthony Rowe
|| ''Parameters'': nrk_sig_mask_t event mask of signal to wait on, use SIG() macro with signal value ||
83 36 Anthony Rowe
|| ''Return Values:'' nrk_sig_mask_t signal mask that triggered wakeup ||
84 1 Anthony Rowe
85 1 Anthony Rowe
This function will wait for a set events. nano-RK supports up to 32 signals. Each signal
86 23 Anthony Rowe
represents a bit in a 32 bit number so it is possible to logically
87 1 Anthony Rowe
OR multiple signals together if you wish to wait on a combination of events. The 32
88 23 Anthony Rowe
bit number returned by nrk_event_wait() corresponds to the signal or signals that were returned.
89 23 Anthony Rowe
When waiting on multiple signals, the return value can be used to determine which signal
90 1 Anthony Rowe
triggered the wakeup. All signals need to be registered in order for a task to receive them.
91 1 Anthony Rowe
This function returns 0 upon failure if a signal is specified that does not exist, or is not
92 1 Anthony Rowe
registered.
93 23 Anthony Rowe
94 24 Anthony Rowe
{{{
95 24 Anthony Rowe
#!c
96 24 Anthony Rowe
  nrk_sig_mask_t my_sigs;
97 24 Anthony Rowe
  int8_t v;
98 23 Anthony Rowe
99 24 Anthony Rowe
  // Don't forget to register signal for reception
100 24 Anthony Rowe
  v=nrk_signal_register(signal_one);
101 24 Anthony Rowe
  if(v==NRK_ERROR) nrk_kprintf( PSTR( "nrk_signal_register failed\r\n" ));
102 24 Anthony Rowe
  v=nrk_signal_register(signal_two);
103 24 Anthony Rowe
  if(v==NRK_ERROR) nrk_kprintf( PSTR( "nrk_signal_register failed\r\n" ));
104 24 Anthony Rowe
105 24 Anthony Rowe
  ...
106 24 Anthony Rowe
  // Waiting on signal_one OR signal_two
107 24 Anthony Rowe
  my_sigs=nrk_event_wait( SIG(signal_one) | SIG(signal_two) );
108 24 Anthony Rowe
109 24 Anthony Rowe
  if(my_sigs==0) nrk_kprintf( PSTR( "nrk_event_wait failed\r\n" ));
110 24 Anthony Rowe
  if(my_sigs & SIG(signal_one))
111 24 Anthony Rowe
     nrk_kprintf( PSTR( "Task got signal 1\r\n") );
112 24 Anthony Rowe
  if(my_sigs & SIG(signal_two))
113 24 Anthony Rowe
     nrk_kprintf( PSTR( "Task got timeout signal2\r\n") );
114 24 Anthony Rowe
}}}
115 24 Anthony Rowe
116 23 Anthony Rowe
'''int8_t nrk_signal_register(nrk_sig_t sig_id);'''
117 23 Anthony Rowe
118 23 Anthony Rowe
This function registers a signal ''sig_id'' so that a task is able to receive it.  This function returns NRK_OK upon success and NRK_ERROR upon failure if the signal does not exist.  A signal only needs to be registered for reception and not transmission.
119 24 Anthony Rowe
120 24 Anthony Rowe
{{{
121 24 Anthony Rowe
#!c
122 24 Anthony Rowe
  v=nrk_signal_register(signal_two);
123 24 Anthony Rowe
  if(v==NRK_ERROR) nrk_kprintf( PSTR( "Error calling nrk_signal_register\r\n" ));
124 24 Anthony Rowe
}}}
125 24 Anthony Rowe
126 23 Anthony Rowe
127 23 Anthony Rowe
'''int8_t nrk_signal_unregister(nrk_sig_t sig_id);'''
128 23 Anthony Rowe
129 23 Anthony Rowe
This function unregisters a signal ''sig_id'' so that the task is no longer able to be unsuspended by that event.  This function returns NRK_OK upon success and NRK_ERROR uopn failure.
130 23 Anthony Rowe
131 23 Anthony Rowe
132 27 Anthony Rowe
'''nrk_sig_mask_t nrk_signal_get_registered_mask();'''
133 23 Anthony Rowe
134 23 Anthony Rowe
This function returns the current registered signal mask for a task.
135 11 Anthony Rowe
136 11 Anthony Rowe
= Semaphores =
137 11 Anthony Rowe
138 11 Anthony Rowe
A semaphore is a protected variable and constitutes the classic method for restricting
139 11 Anthony Rowe
access to shared resources (e.g. storage,actuators etc) in a multiprogramming environment.
140 11 Anthony Rowe
Nano-RK implements semaphores and signals such that
141 12 Anthony Rowe
tasks that are suspended on an event or waiting for access to a semaphore will not be
142 12 Anthony Rowe
scheduled until the corresponding signal is sent or semaphore becomes available. For more information
143 12 Anthony Rowe
on using semaphores please refer to the basic_sem project that comes with the Nano-RK distribution: 
144 40 Anthony Rowe
[http://www.nanork.org/browser/nano-RK/projects/basic_sem/main.c basic_sem]
145 16 Anthony Rowe
146 16 Anthony Rowe
''Note that the Atmel ISA does not have a test-and-set instruction, so we provide a best effort implementation by disabling interrupts.'' 
147 10 Anthony Rowe
148 1 Anthony Rowe
'''nrk_sem_t* nrk_sem_create(uint8_t count, uint8_t ceiling_priority);'''
149 10 Anthony Rowe
150 10 Anthony Rowe
This function creates a semaphore resource, with a priority ceiling value used by the task when accessing the resource. This facilitates the Priority Ceiling Protocol Emulation (PCPE) algorithm used in Nano-RK to avoid priority inversion. ''count'' specifies the number of entries allowed into the critical section. ''ceiling_priority'' sets the ceiling value for the task; Note if
151 10 Anthony Rowe
using PCPE this should be the highest priority task accessing the critical section.  Below is an example of declaring and creating a semaphore:
152 10 Anthony Rowe
153 10 Anthony Rowe
{{{
154 10 Anthony Rowe
#!c
155 10 Anthony Rowe
   nrk_sem_t *my_semaphore;
156 10 Anthony Rowe
   ...
157 10 Anthony Rowe
   my_semaphore = nrk_sem_create(1,4);
158 10 Anthony Rowe
   if(my_semaphore==NULL) nrk_kprintf( PSTR("Error creating Semaphore\r\n" ));
159 10 Anthony Rowe
}}}
160 10 Anthony Rowe
161 1 Anthony Rowe
This created a semaphore with a count of 1 (also called a mutex or binary semaphore) with a priority ceiling value of 4.
162 1 Anthony Rowe
163 37 Anthony Rowe
'''int8_t nrk_sem_delete(nrk_sem_t *rsrc );''' 
164 37 Anthony Rowe
165 38 Anthony Rowe
This function deletes an existing semaphore which will free the resource for reuse.  This function returns NRK_OK upon success and NRK_ERROR on failure.  Errno is set depending on the error type:
166 37 Anthony Rowe
 * Errno
167 37 Anthony Rowe
  * 1 Signal Not Found
168 37 Anthony Rowe
  * 2 Signal Index too large
169 37 Anthony Rowe
170 37 Anthony Rowe
171 1 Anthony Rowe
'''int8_t nrk_sem_pend(nrk_sem_t *rsrc );''' 
172 8 Anthony Rowe
173 8 Anthony Rowe
Semaphore pend takes the address of the created semaphore and attempts to access the resource.  If the resource is available,
174 8 Anthony Rowe
pend will decrement the resource counter and allow the program to continue, otherwise pend will suspend until the resource is
175 1 Anthony Rowe
posted by another task. This can be used to protect critical sections of code. Below is an example of a task pending on a semaphore:
176 31 Anthony Rowe
 * Errno
177 30 Anthony Rowe
  * 1 Signal Not Found
178 30 Anthony Rowe
  * 2 Signal Index too large
179 1 Anthony Rowe
180 1 Anthony Rowe
{{{
181 1 Anthony Rowe
#!c
182 1 Anthony Rowe
   nrk_kprintf( PSTR("Task accessing semaphore\r\n"));
183 1 Anthony Rowe
   v = nrk_sem_pend(my_semaphore);
184 1 Anthony Rowe
   if(v==NRK_ERROR) nrk_kprintf( PSTR("Error calling pend\r\n"));
185 9 Anthony Rowe
   nrk_kprintf( PSTR("Task is now holding semaphore\r\n"));
186 9 Anthony Rowe
}}}
187 9 Anthony Rowe
188 9 Anthony Rowe
'''int8_t nrk_sem_post(nrk_sem_t* rsrc);'''
189 9 Anthony Rowe
190 9 Anthony Rowe
Semaphore post takes the address of a created semaphore and releases access to the resource.
191 1 Anthony Rowe
This should be called after exiting a critical section that was pended.  Below is an example of a task posting a semaphore:
192 31 Anthony Rowe
 * Errno
193 30 Anthony Rowe
  * 1 Signal Not Found
194 30 Anthony Rowe
  * 2 Signal Index too large
195 9 Anthony Rowe
{{{
196 9 Anthony Rowe
#!c
197 9 Anthony Rowe
   v = nrk_sem_post(my_semaphore);
198 9 Anthony Rowe
   if(v==NRK_ERROR) nrk_kprintf( PSTR("Error calling post\r\n"));
199 8 Anthony Rowe
   nrk_kprintf( PSTR("Task released semaphore\r\n"));
200 8 Anthony Rowe
}}}
201 11 Anthony Rowe
202 34 Anthony Rowe
203 34 Anthony Rowe
'''int8_t nrk_sem_query(nrk_sem_t *rsrc );''' 
204 34 Anthony Rowe
205 34 Anthony Rowe
This returns the current count value of the semaphore.  This can be used to check if the semaphore will allow access without actually trying to lock it.
206 34 Anthony Rowe
 * Errno
207 34 Anthony Rowe
  * 1 Signal Not Found
208 34 Anthony Rowe
  * 2 Signal Index too large
209 34 Anthony Rowe
210 34 Anthony Rowe
211 8 Anthony Rowe
= Special Kernel Signals =
212 18 Anthony Rowe
213 20 Anthony Rowe
'''nrk_wakeup_signal'''
214 19 Anthony Rowe
215 33 Anthony Rowe
Sometimes it might be convenient to have a timeout associated with an nrk_event_wait() call.   This can be achieved using the kernel generated nrk_wakeup_signal.  This signal is sent on a per-task basis (not globally) when the task’s internal next-wakeup timer expires.  Normally, a task’s next wakeup is set for its next period, however this can be adjusted using the nrk_set_next_wakeup() function. nrk_wakeup_signal is created by the kernel during nrk_init().  In order for nrk_event_wait() to receive the nrk_wakeup_signal from a task it must simply be registered and muxed in like any other signal.  Note, each task has its own instance of the nrk_wakeup_signal.  Unlike other signals, nrk_wakeup_signal is not globally broadcast to all tasks.  See below for an example of how to use it as an event  timeout.
216 19 Anthony Rowe
217 20 Anthony Rowe
'''int8_t nrk_set_next_wakeup(nrk_time_t timeout);'''
218 19 Anthony Rowe
219 19 Anthony Rowe
This function sets the task's next wakeup timer.  It returns NRK_OK upon success and NRK_ERROR on failure.  This function does not
220 18 Anthony Rowe
suspend the task, it only changes when the next wakeup will happen if the task suspends on an event.  Calling other suspend functions like nrk_wait_until_next_period() will replace whatever wakeup value you might have previously set. 
221 17 Anthony Rowe
222 17 Anthony Rowe
{{{
223 17 Anthony Rowe
#!c
224 8 Anthony Rowe
   nrk_time_t timeout;
225 17 Anthony Rowe
226 17 Anthony Rowe
   timeout.secs=10;
227 1 Anthony Rowe
   timeout.nano_secs=0;
228 1 Anthony Rowe
   ...
229 1 Anthony Rowe
230 17 Anthony Rowe
   nrk_set_next_wakeup(timeout);
231 17 Anthony Rowe
   my_sigs=nrk_event_wait( SIG(signal_one) | SIG(nrk_wakeup_signal) );
232 21 Anthony Rowe
233 18 Anthony Rowe
   // Lets check which signal we got...
234 18 Anthony Rowe
   if(my_sigs==0)                        nrk_kprintf( PSTR( "Error calling nrk_event_wait()\r\n" ));
235 18 Anthony Rowe
   if(my_sigs & SIG(signal_one))         nrk_kprintf( PSTR( "Task got signal_one\r\n") );
236 17 Anthony Rowe
   if(my_sigs & SIG(nrk_wakeup_signal))  nrk_kprintf( PSTR( "Task got timeout signal! \r\n") );
237 1 Anthony Rowe
}}}
238 1 Anthony Rowe
239 1 Anthony Rowe
| [wiki:nrk-api Contents] | [wiki:nrk-api-device-drivers Device Drivers] |