Nrk-api-signals-semaphores

Version 27 (Anthony Rowe, 06/08/2007 10:31 pm)

1 11 Anthony Rowe
= Signals =
2 1 Anthony Rowe
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 14 Anthony Rowe
http://www.nanork.org:8000/nano-RK/browser/nano-RK/projects/basic_signals/main.c
13 1 Anthony Rowe
14 11 Anthony Rowe
15 5 Anthony Rowe
{{{
16 5 Anthony Rowe
#!c
17 5 Anthony Rowe
// This is a macro used to convert a signal into a bitmask for nrk_event_wait()
18 5 Anthony Rowe
// See nrk_event_wait() for an example.
19 5 Anthony Rowe
#define SIG(x)  ((uint32_t)1)<<x 
20 5 Anthony Rowe
21 5 Anthony Rowe
// These are typedefs used to represent signals and semaphores
22 5 Anthony Rowe
typedef int8_t nrk_sig_t;
23 5 Anthony Rowe
typedef uint32_t nrk_sig_mask_t;
24 5 Anthony Rowe
typedef int8_t nrk_sem_t;
25 5 Anthony Rowe
}}}
26 5 Anthony Rowe
27 5 Anthony Rowe
28 23 Anthony Rowe
'''nrk_sig_t nrk_signal_create();'''
29 1 Anthony Rowe
30 23 Anthony Rowe
This function creates a signal.  Upon failure, this function returns NRK_ERROR.  Upon success a positive value
31 23 Anthony Rowe
representing the signal is returned.
32 23 Anthony Rowe
33 24 Anthony Rowe
{{{
34 24 Anthony Rowe
  nrk_sig_t signal_one;
35 24 Anthony Rowe
  nrk_sig_t signal_two;
36 24 Anthony Rowe
  ...
37 24 Anthony Rowe
                    
38 24 Anthony Rowe
  signal_one=nrk_signal_create();
39 24 Anthony Rowe
  signal_two=nrk_signal_create();
40 24 Anthony Rowe
}}}
41 24 Anthony Rowe
42 26 Anthony Rowe
'''int8_t nrk_signal_delete(nrk_sig_t sig_id);'''
43 1 Anthony Rowe
44 23 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.
45 1 Anthony Rowe
46 1 Anthony Rowe
'''int8_t nrk_event_signal(nrk_sig_t sig_id);'''
47 1 Anthony Rowe
48 1 Anthony Rowe
This function is used to signal tasks that are waiting on events using nrk_event_wait().
49 23 Anthony Rowe
''sig_id'' is the signal that is sent.  This function returns NRK_OK upon success and NRK_ERROR upon failure.
50 23 Anthony Rowe
If a lower priority task signals a higher priority task, the high priority task will begin to execute at 
51 23 Anthony Rowe
the next context swap.  Normally this happens when the low priority task suspends, but it is also possible
52 23 Anthony Rowe
that a medium priority task could preempt the low priority task causing a context swap that would then
53 23 Anthony Rowe
schedule the waiting high priority task.  For this reason, processing that needs to be complete before the signaled task
54 23 Anthony Rowe
executes should be done before the signals are sent. 
55 1 Anthony Rowe
56 24 Anthony Rowe
{{{
57 24 Anthony Rowe
#!c
58 24 Anthony Rowe
   v=nrk_event_signal( signal_one );
59 25 Anthony Rowe
   if(v==NRK_ERROR) nrk_kprintf( PSTR( "nrk_event_signal failed\r\n" ));
60 24 Anthony Rowe
}}}
61 4 Anthony Rowe
62 1 Anthony Rowe
'''nrk_sig_mask_t nrk_event_wait(nrk_sig_mask_t event_mask);'''
63 1 Anthony Rowe
64 1 Anthony Rowe
This function will wait for a set events. nano-RK supports up to 32 signals. Each signal
65 23 Anthony Rowe
represents a bit in a 32 bit number so it is possible to logically
66 1 Anthony Rowe
OR multiple signals together if you wish to wait on a combination of events. The 32
67 23 Anthony Rowe
bit number returned by nrk_event_wait() corresponds to the signal or signals that were returned.
68 23 Anthony Rowe
When waiting on multiple signals, the return value can be used to determine which signal
69 1 Anthony Rowe
triggered the wakeup. All signals need to be registered in order for a task to receive them.
70 1 Anthony Rowe
This function returns 0 upon failure if a signal is specified that does not exist, or is not
71 1 Anthony Rowe
registered.
72 23 Anthony Rowe
73 24 Anthony Rowe
{{{
74 24 Anthony Rowe
#!c
75 24 Anthony Rowe
  nrk_sig_mask_t my_sigs;
76 24 Anthony Rowe
  int8_t v;
77 23 Anthony Rowe
78 24 Anthony Rowe
  // Don't forget to register signal for reception
79 24 Anthony Rowe
  v=nrk_signal_register(signal_one);
80 24 Anthony Rowe
  if(v==NRK_ERROR) nrk_kprintf( PSTR( "nrk_signal_register failed\r\n" ));
81 24 Anthony Rowe
  v=nrk_signal_register(signal_two);
82 24 Anthony Rowe
  if(v==NRK_ERROR) nrk_kprintf( PSTR( "nrk_signal_register failed\r\n" ));
83 24 Anthony Rowe
84 24 Anthony Rowe
  ...
85 24 Anthony Rowe
  // Waiting on signal_one OR signal_two
86 24 Anthony Rowe
  my_sigs=nrk_event_wait( SIG(signal_one) | SIG(signal_two) );
87 24 Anthony Rowe
88 24 Anthony Rowe
  if(my_sigs==0) nrk_kprintf( PSTR( "nrk_event_wait failed\r\n" ));
89 24 Anthony Rowe
  if(my_sigs & SIG(signal_one))
90 24 Anthony Rowe
     nrk_kprintf( PSTR( "Task got signal 1\r\n") );
91 24 Anthony Rowe
  if(my_sigs & SIG(signal_two))
92 24 Anthony Rowe
     nrk_kprintf( PSTR( "Task got timeout signal2\r\n") );
93 24 Anthony Rowe
}}}
94 24 Anthony Rowe
95 23 Anthony Rowe
'''int8_t nrk_signal_register(nrk_sig_t sig_id);'''
96 23 Anthony Rowe
97 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.
98 24 Anthony Rowe
99 24 Anthony Rowe
{{{
100 24 Anthony Rowe
#!c
101 24 Anthony Rowe
  v=nrk_signal_register(signal_two);
102 24 Anthony Rowe
  if(v==NRK_ERROR) nrk_kprintf( PSTR( "Error calling nrk_signal_register\r\n" ));
103 24 Anthony Rowe
}}}
104 24 Anthony Rowe
105 23 Anthony Rowe
106 23 Anthony Rowe
'''int8_t nrk_signal_unregister(nrk_sig_t sig_id);'''
107 23 Anthony Rowe
108 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.
109 23 Anthony Rowe
110 23 Anthony Rowe
111 27 Anthony Rowe
'''nrk_sig_mask_t nrk_signal_get_registered_mask();'''
112 23 Anthony Rowe
113 23 Anthony Rowe
This function returns the current registered signal mask for a task.
114 11 Anthony Rowe
115 11 Anthony Rowe
= Semaphores =
116 11 Anthony Rowe
117 11 Anthony Rowe
A semaphore is a protected variable and constitutes the classic method for restricting
118 11 Anthony Rowe
access to shared resources (e.g. storage,actuators etc) in a multiprogramming environment.
119 11 Anthony Rowe
Nano-RK implements semaphores and signals such that
120 12 Anthony Rowe
tasks that are suspended on an event or waiting for access to a semaphore will not be
121 12 Anthony Rowe
scheduled until the corresponding signal is sent or semaphore becomes available. For more information
122 12 Anthony Rowe
on using semaphores please refer to the basic_sem project that comes with the Nano-RK distribution: 
123 11 Anthony Rowe
http://www.nanork.org:8000/nano-RK/browser/nano-RK/projects/basic_sem/main.c
124 16 Anthony Rowe
125 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.'' 
126 10 Anthony Rowe
127 1 Anthony Rowe
'''nrk_sem_t* nrk_sem_create(uint8_t count, uint8_t ceiling_priority);'''
128 10 Anthony Rowe
129 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
130 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:
131 10 Anthony Rowe
132 10 Anthony Rowe
{{{
133 10 Anthony Rowe
#!c
134 10 Anthony Rowe
   nrk_sem_t *my_semaphore;
135 10 Anthony Rowe
   ...
136 10 Anthony Rowe
   my_semaphore = nrk_sem_create(1,4);
137 10 Anthony Rowe
   if(my_semaphore==NULL) nrk_kprintf( PSTR("Error creating Semaphore\r\n" ));
138 10 Anthony Rowe
}}}
139 10 Anthony Rowe
140 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.
141 1 Anthony Rowe
142 1 Anthony Rowe
'''int8_t nrk_sem_pend(nrk_sem_t *rsrc );''' 
143 8 Anthony Rowe
144 8 Anthony Rowe
Semaphore pend takes the address of the created semaphore and attempts to access the resource.  If the resource is available,
145 8 Anthony Rowe
pend will decrement the resource counter and allow the program to continue, otherwise pend will suspend until the resource is
146 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:
147 1 Anthony Rowe
148 1 Anthony Rowe
{{{
149 1 Anthony Rowe
#!c
150 1 Anthony Rowe
   nrk_kprintf( PSTR("Task accessing semaphore\r\n"));
151 1 Anthony Rowe
   v = nrk_sem_pend(my_semaphore);
152 1 Anthony Rowe
   if(v==NRK_ERROR) nrk_kprintf( PSTR("Error calling pend\r\n"));
153 9 Anthony Rowe
   nrk_kprintf( PSTR("Task is now holding semaphore\r\n"));
154 9 Anthony Rowe
}}}
155 9 Anthony Rowe
156 9 Anthony Rowe
'''int8_t nrk_sem_post(nrk_sem_t* rsrc);'''
157 9 Anthony Rowe
158 9 Anthony Rowe
Semaphore post takes the address of a created semaphore and releases access to the resource.
159 9 Anthony Rowe
This should be called after exiting a critical section that was pended.  Below is an example of a task posting a semaphore:
160 1 Anthony Rowe
161 9 Anthony Rowe
{{{
162 9 Anthony Rowe
#!c
163 9 Anthony Rowe
   v = nrk_sem_post(my_semaphore);
164 9 Anthony Rowe
   if(v==NRK_ERROR) nrk_kprintf( PSTR("Error calling post\r\n"));
165 8 Anthony Rowe
   nrk_kprintf( PSTR("Task released semaphore\r\n"));
166 8 Anthony Rowe
}}}
167 11 Anthony Rowe
168 8 Anthony Rowe
= Special Kernel Signals =
169 18 Anthony Rowe
170 20 Anthony Rowe
'''nrk_wakeup_signal'''
171 19 Anthony Rowe
172 1 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, it is not globally broadcast to all tasks.  See below for an example of how to use it as an event  timeout.
173 19 Anthony Rowe
174 20 Anthony Rowe
'''int8_t nrk_set_next_wakeup(nrk_time_t timeout);'''
175 19 Anthony Rowe
176 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
177 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. 
178 17 Anthony Rowe
179 17 Anthony Rowe
{{{
180 17 Anthony Rowe
#!c
181 8 Anthony Rowe
   nrk_time_t timeout;
182 17 Anthony Rowe
183 17 Anthony Rowe
   timeout.secs=10;
184 1 Anthony Rowe
   timeout.nano_secs=0;
185 1 Anthony Rowe
   ...
186 1 Anthony Rowe
187 17 Anthony Rowe
   nrk_set_next_wakeup(timeout);
188 17 Anthony Rowe
   my_sigs=nrk_event_wait( SIG(signal_one) | SIG(nrk_wakeup_signal) );
189 21 Anthony Rowe
190 18 Anthony Rowe
   // Lets check which signal we got...
191 18 Anthony Rowe
   if(my_sigs==0)                        nrk_kprintf( PSTR( "Error calling nrk_event_wait()\r\n" ));
192 18 Anthony Rowe
   if(my_sigs & SIG(signal_one))         nrk_kprintf( PSTR( "Task got signal_one\r\n") );
193 17 Anthony Rowe
   if(my_sigs & SIG(nrk_wakeup_signal))  nrk_kprintf( PSTR( "Task got timeout signal! \r\n") );
194 1 Anthony Rowe
}}}
195 1 Anthony Rowe
196 1 Anthony Rowe
| [wiki:nrk-api Contents] | [wiki:nrk-api-device-drivers Device Drivers] |