Skip to content

Commit 27fc033

Browse files
Update formatting changes using <br> tags (#76)
* Update formatting changes using <br> tags * Update Ch07.md * Update booktitle.md * Update booktitle.md * Update booktitle.md * Update copyright.md * Update copyright.md * Update dedication.md * Update dedication.md --------- Co-authored-by: Nishant <114558872+sirnish@users.noreply.github.com>
1 parent 510d704 commit 27fc033

File tree

10 files changed

+168
-55
lines changed

10 files changed

+168
-55
lines changed

booktitle.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
<div align="center">
22

3+
</br>
4+
</br>
5+
36
<img src="./media/freeRTOS.png" alt="" height="180" width="250"/>
47

58

@@ -15,10 +18,41 @@
1518
</br>
1619
</br>
1720
</br>
18-
</br>
1921

2022
</div>
2123

24+
25+
</br>
26+
</br>
27+
</br>
28+
</br>
29+
</br>
30+
</br>
31+
</br>
32+
</br>
33+
</br>
34+
</br>
35+
</br>
36+
</br>
37+
</br>
38+
</br>
39+
</br>
40+
</br>
41+
</br>
42+
</br>
43+
</br>
44+
</br>
45+
</br>
46+
</br>
47+
</br>
48+
</br>
49+
</br>
50+
</br>
51+
</br>
52+
</br>
53+
</br>
54+
</br>
55+
</br>
2256
</br>
2357
</br>
2458
</br>
@@ -31,6 +65,9 @@
3165
</br>
3266

3367

34-
68+
<div align = "left">
69+
3570
[^1]: FreeRTOS™, FreeRTOS.org™ and the FreeRTOS logo are trademarks of Amazon Web Services.
3671
[^2]: OPEN**RTOS**<sup>®</sup> and SAFE**RTOS**<sup>®</sup> are trademarks of WITTENSTEIN High Integrity Systems Ltd. All other brands or product names are the property of their respective holders.
72+
73+
</div>

ch04.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ BaseType_t xTaskCreate( TaskFunction_t pvTaskCode,
255255
information on heap memory management.
256256
257257
258-
<a name="example4.1" title="Creating tasks"></a>
258+
<a name="example4.1" title="Example 4.1 Creating tasks"></a>
259259
---
260260
***Example 4.1*** *Creating tasks*
261261
@@ -479,7 +479,7 @@ void vTask1( void * pvParameters )
479479
480480
***Listing 4.7*** *Creating a task from within another task after the scheduler has started*
481481
482-
<a name="example4.2" title="Using the task parameter"></a>
482+
<a name="example4.2" title="Example 4.2 Using the task parameter"></a>
483483
---
484484
***Example 4.2*** *Using the task parameter*
485485
@@ -739,7 +739,7 @@ internally.
739739
describes configuration constants which affect when the scheduler will
740740
select a new task to run and when a tick interrupt will execute.
741741

742-
<a name="example4.3" title="Experimenting with priorities"></a>
742+
<a name="example4.3" title="Example 4.3 Experimenting with priorities"></a>
743743
---
744744
***Example 4.3*** *Experimenting with priorities*
745745

@@ -918,7 +918,7 @@ Figure 4.7 expands on the simplified state diagram to include all of the
918918
***Figure 4.7*** *Full task state machine*
919919
***
920920

921-
<a name="example4.4" title="Using the Blocked state to create a delay"></a>
921+
<a name="example4.4" title="Example 4.4 Using the Blocked state to create a delay"></a>
922922
---
923923
***Example 4.4*** *Using the *Blocked* state to create a delay</i></h3>
924924

@@ -1157,7 +1157,7 @@ void vTaskDelayUntil( TickType_t * pxPreviousWakeTime,
11571157
be used to convert a time specified in milliseconds into a time
11581158
specified in ticks.
11591159
1160-
<a name="example4.5" title="Converting the example tasks to use vTaskDelayUntil()"></a>
1160+
<a name="example4.5" title="Example 4.5 Converting the example tasks to use vTaskDelayUntil()"></a>
11611161
---
11621162
***Example 4.5*** *Converting the example tasks to use vTaskDelayUntil()*
11631163
@@ -1216,7 +1216,7 @@ void vTaskFunction( void * pvParameters )
12161216
The output produced by Example 4.5 is exactly as per that shown for Example 4.4
12171217
in Figure 4.8.
12181218

1219-
<a name="example4.6" title="Combining blocking and non-blocking tasks"></a>
1219+
<a name="example4.6" title="Example 4.6 Combining blocking and non-blocking tasks"></a>
12201220
---
12211221
***Example 4.6*** *Combining blocking and non-blocking tasks*
12221222

@@ -1445,7 +1445,7 @@ void vApplicationIdleHook( void );
14451445
14461446
***Listing 4.18*** *The idle task hook function name and prototype*
14471447
1448-
<a name="example4.7" title="Defining an idle task hook function"></a>
1448+
<a name="example4.7" title="Example 4.7 Defining an idle task hook function"></a>
14491449
---
14501450
***Example 4.7*** *Defining an idle task hook function</i></h3>
14511451
@@ -1627,7 +1627,7 @@ UBaseType_t uxTaskPriorityGet( TaskHandle_t xTask );
16271627
The priority currently assigned to the task being queried.
16281628

16291629

1630-
<a name="example4.8" title="Changing task priorities"></a>
1630+
<a name="example4.8" title="Example 4.8 Changing task priorities"></a>
16311631
---
16321632
***Example 4.8*** *Changing task priorities*
16331633

@@ -1887,7 +1887,7 @@ void vTaskDelete( TaskHandle_t xTaskToDelete );
18871887
handle.
18881888
18891889
1890-
<a name="example4.9" title="Deleting tasks"></a>
1890+
<a name="example4.9" title="Example 4.9 Deleting tasks"></a>
18911891
---
18921892
***Example 4.9*** *Deleting tasks*
18931893

ch05.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ UBaseType_t uxQueueMessagesWaiting( QueueHandle_t xQueue );
408408
then the queue is empty.
409409
410410
411-
<a name="example5.1" title="Blocking when receiving from a queue"></a>
411+
<a name="example5.1" title="Example 5.1 Blocking when receiving from a queue"></a>
412412
---
413413
***Example 5.1*** *Blocking when receiving from a queue*
414414
@@ -663,7 +663,7 @@ Chapter (RB-TBD) shows how to extend this design pattern such that
663663
the controller task can reply directly to the task that queued a structure.
664664

665665

666-
<a name="example5.2" title="Blocking when sending to a queue, and sending structures on a queue"></a>
666+
<a name="example5.2" title="Example 5.2 Blocking when sending to a queue, and sending structures on a queue"></a>
667667
---
668668
***Example 5.2*** *Blocking when sending to a queue, and sending structures on a queue*
669669

@@ -1486,7 +1486,7 @@ QueueSetMemberHandle_t xQueueSelectFromSet( QueueSetHandle_t xQueueSet,
14861486
in the set, but the block time expired before that happened.
14871487
14881488
1489-
<a name="example5.3" title="Using a Queue Set"></a>
1489+
<a name="example5.3" title="Example 5.3 Using a Queue Set"></a>
14901490
---
14911491
***Example 5.3*** *Using a Queue Set</i></h3>
14921492

ch06.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -578,7 +578,7 @@ BaseType_t xTimerStart( TimerHandle_t xTimer, TickType_t xTicksToWait );
578578
specified block time expired before that happened.
579579

580580

581-
<a name="example6.1" title="Creating one-shot and auto-reload timers"></a>
581+
<a name="example6.1" title="Example 6.1 Creating one-shot and auto-reload timers"></a>
582582
---
583583
***Example 6.1*** *Creating one-shot and auto-reload timers*
584584

@@ -782,7 +782,7 @@ void *pvTimerGetTimerID( const TimerHandle_t xTimer );
782782
The ID of the software timer being queried.
783783
784784
785-
<a name="example6.2" title="Using the callback function parameter and the software timer ID"></a>
785+
<a name="example6.2" title="Example 6.2 Using the callback function parameter and the software timer ID"></a>
786786
---
787787
***Example 6.2*** *Using the callback function parameter and the software timer ID*
788788
@@ -1173,7 +1173,7 @@ BaseType_t xTimerReset( TimerHandle_t xTimer, TickType_t xTicksToWait );
11731173
expired before that happened.
11741174

11751175

1176-
<a name="example6.3" title="Resetting a software timer"></a>
1176+
<a name="example6.3" title="Example 6.3 Resetting a software timer"></a>
11771177
---
11781178
***Example 6.3*** *Resetting a software timer*
11791179

ch07.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -616,7 +616,7 @@ BaseType_t xSemaphoreGiveFromISR( SemaphoreHandle_t xSemaphore,
616616
`xSemaphoreGiveFromISR()` will return `pdFAIL`.
617617
618618
619-
<a name="example7.1" title="Using a binary semaphore to synchronize a task with an interrupt"></a>
619+
<a name="example7.1" title="Example 7.1 Using a binary semaphore to synchronize a task with an interrupt"></a>
620620
---
621621
***Example 7.1*** *Using a binary semaphore to synchronize a task with an interrupt*
622622
@@ -1075,15 +1075,15 @@ SemaphoreHandle_t xSemaphoreCreateCounting( UBaseType_t uxMaxCount,
10751075
10761076
If NULL is returned, the semaphore cannot be created because
10771077
there is insufficient heap memory available for FreeRTOS to allocate the
1078-
semaphore data structures. Chapter 2 provides more information on heap
1078+
semaphore data structures. Chapter 3 provides more information on heap
10791079
memory management.
10801080
10811081
If a non-NULL value is returned, it indicates that the semaphore has been
10821082
created successfully. The returned value should be stored as the handle
10831083
to the created semaphore.
10841084
10851085
1086-
<a name="example7.2" title="Using a counting semaphore to synchronize a task with an interrupt"></a>
1086+
<a name="example7.2" title="Example 7.2 Using a counting semaphore to synchronize a task with an interrupt"></a>
10871087
---
10881088
***Example 7.2*** *Using a counting semaphore to synchronize a task with an interrupt*
10891089
@@ -1310,7 +1310,7 @@ void vPendableFunction( void *pvParameter1, uint32_t ulParameter2 );
13101310
command queue.
13111311
13121312
1313-
<a name="example7.3" title="Centralized deferred interrupt processing"></a>
1313+
<a name="example7.3" title="Example 7.3 Centralized deferred interrupt processing"></a>
13141314
---
13151315
***Example 7.3*** *Centralized deferred interrupt processing*
13161316
@@ -1583,7 +1583,7 @@ that are suitable for production code, include:
15831583
than the raw data) to a task. This was previously demonstrated by
15841584
Figure 5.4.
15851585

1586-
<a name="example7.4" title="Sending and receiving on a queue from within an interrupt"></a>
1586+
<a name="example7.4" title="Example 7.4 Sending and receiving on a queue from within an interrupt"></a>
15871587
---
15881588
***Example 7.4*** *Sending and receiving on a queue from within an interrupt*
15891589

ch08.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -513,7 +513,7 @@ SemaphoreHandle_t xSemaphoreCreateMutex( void );
513513
created mutex.
514514

515515

516-
<a name="example8.1" title="Rewriting vPrintString() to use a semaphore"></a>
516+
<a name="example8.1" title="Example 8.1 Rewriting vPrintString() to use a semaphore"></a>
517517
---
518518
***Example 8.1*** *Rewriting vPrintString() to use a semaphore*
519519

@@ -1139,7 +1139,7 @@ static void prvStdioGatekeeperTask( void *pvParameters )
11391139
***Listing 8.18*** *The gatekeeper task*
11401140

11411141

1142-
<a name="example8.2" title="The alternative implementation for print task"></a>
1142+
<a name="example8.2" title="Example 8.2 The alternative implementation for print task"></a>
11431143
---
11441144
***Example 8.2*** *The alternative implementation for print task*
11451145

ch09.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,7 @@ StaticEventGroup_t ** ppxEventGroupBuffer );
520520
521521
- `pdFALSE` will be returned if the buffer was not successfully retrieved.
522522
523-
<a name="example9.1" title="Experimenting with event groups"></a>
523+
<a name="example9.1" title="Example 9.1 Experimenting with event groups"></a>
524524
---
525525
***Example 9.1*** *Experimenting with event groups*
526526
@@ -1034,7 +1034,7 @@ EventBits_t xEventGroupSync( EventGroupHandle_t xEventGroup,
10341034
condition.
10351035

10361036

1037-
<a name="example9.2" title="Synchronizing tasks"></a>
1037+
<a name="example9.2" title="Example 9.2 Synchronizing tasks"></a>
10381038
---
10391039
***Example 9.2*** *Synchronizing tasks*
10401040

ch10.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -181,26 +181,26 @@ macros will be called functions throughout this book.
181181

182182
#### 10.3.1.1 The complete list of API functions <sup>27</sup>
183183

184-
`xTaskNotifyGive`
185-
`xTaskNotifyGiveIndexed`
186-
`vTaskNotifyGiveFromISR`
187-
`vTaskNotifyGiveIndexedFromISR`
188-
`vTaskNotifyTake`
189-
`vTaskNotifyTakeIndexed`
190-
`xTaskNotify`
191-
`xTaskNotifyIndexed`
192-
`xTaskNotifyWait`
193-
`xTaskNotifyWaitIndexed`
194-
`xTaskNotifyStateClear`
195-
`xTaskNotifyStateClearIndexed`
196-
`ulTaskNotifyValueClear`
197-
`ulTaskNotifyValueClearIndexed`
198-
`xTaskNotifyAndQueryIndexedFromISR`
199-
`xTaskNotifyAndQueryFromISR`
200-
`xTaskNotifyFromISR`
201-
`xTaskNotifyIndexedFromISR`
202-
`xTaskNotifyAndQuery`
203-
`xTaskNotifyAndQueryIndexed`
184+
- `xTaskNotifyGive`
185+
- `xTaskNotifyGiveIndexed`
186+
- `vTaskNotifyGiveFromISR`
187+
- `vTaskNotifyGiveIndexedFromISR`
188+
- `vTaskNotifyTake`
189+
- `vTaskNotifyTakeIndexed`
190+
- `xTaskNotify`
191+
- `xTaskNotifyIndexed`
192+
- `xTaskNotifyWait`
193+
- `xTaskNotifyWaitIndexed`
194+
- `xTaskNotifyStateClear`
195+
- `xTaskNotifyStateClearIndexed`
196+
- `ulTaskNotifyValueClear`
197+
- `ulTaskNotifyValueClearIndexed`
198+
- `xTaskNotifyAndQueryIndexedFromISR`
199+
- `xTaskNotifyAndQueryFromISR`
200+
- `xTaskNotifyFromISR`
201+
- `xTaskNotifyIndexedFromISR`
202+
- `xTaskNotifyAndQuery`
203+
- `xTaskNotifyAndQueryIndexed`
204204

205205
*(27): These functions are actually implemented as macros.*
206206

@@ -359,7 +359,7 @@ xTicksToWait );
359359
the specified block time expired before that happened.
360360
361361
362-
<a name="example10.1" title="Using a task notification in place of a semaphore, method 1"></a>
362+
<a name="example10.1" title="Example 10.1 Using a task notification in place of a semaphore, method 1"></a>
363363
---
364364
***Example 10.1*** *Using a task notification in place of a semaphore, method 1*
365365
@@ -498,7 +498,7 @@ produced by the periodic task. Further explanation is provided in Figure 10.4.
498498
***Figure 10.4*** *The sequence of execution when Example 10.1 is executed*
499499
* * *
500500
501-
<a name="example10.2" title="Using a task notification in place of a semaphore, method 2"></a>
501+
<a name="example10.2" title="Example 10.2 Using a task notification in place of a semaphore, method 2"></a>
502502
---
503503
***Example 10.2*** *Using a task notification in place of a semaphore, method 2*
504504

0 commit comments

Comments
 (0)