-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>AltOS</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book"><div class="titlepage"><div><div><h1 class="title"><a name="idm624
4192"></a>AltOS</h1></div><div><h2 class="subtitle">Altos Metrum Operating System</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Keith</span> <span class="surname">Packard</span></h3></div></div><div><p class="copyright">Copyright © 2010 Keith Packard</p></div><div><div class="legalnotice"><a name="idp48059856"></a><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>AltOS</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book"><div class="titlepage"><div><div><h1 class="title"><a name="idm624
1120"></a>AltOS</h1></div><div><h2 class="subtitle">Altos Metrum Operating System</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Keith</span> <span class="surname">Packard</span></h3></div></div><div><p class="copyright">Copyright © 2010 Keith Packard</p></div><div><div class="legalnotice"><a name="idp47957712"></a><p>
This document is released under the terms of the
<a class="ulink" href="http://creativecommons.org/licenses/by-sa/3.0/" target="_top">
Creative Commons ShareAlike 3.0
</a>
license.
- </p></div></div><div><div class="revhistory"><table style="border-style:solid; width:100%;" summary="Revision History"><tr><th align="left" valign="top" colspan="2"><b>Revision History</b></th></tr><tr><td align="left">Revision 1.1</td><td align="left">05 November 2012</td></tr><tr><td align="left" colspan="2">Portable version</td></tr><tr><td align="left">Revision 0.1</td><td align="left">22 November 2010</td></tr><tr><td align="left" colspan="2">Initial content</td></tr></table></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="chapter"><a href="#idp47884288">1. Overview</a></span></dt><dt><span class="chapter"><a href="#idp48916512">2. AltOS Porting Layer</a></span></dt><dd><dl><dt><span class="section"><a href="#idp48918016">1. Low-level CPU operations</a></span></dt><dd><dl><dt><span class="section"><a href="#idp48919248">1.1. ao_arch_block_interrupts/ao_arch_release_interrupts</a></span></dt><dt><span class="section"><a href="#idp48921296">1.2. ao_arch_save_regs, ao_arch_save_stack,
- ao_arch_restore_stack</a></span></dt><dt><span class="section"><a href="#idp4
9830960">1.3. ao_arch_wait_interupt</a></span></dt></dl></dd><dt><span class="section"><a href="#idp49833504">2. GPIO operations</a></span></dt><dd><dl><dt><span class="section"><a href="#idp49834672">2.1. GPIO setup</a></span></dt><dt><span class="section"><a href="#idp49843888">2.2. Reading and writing GPIO pins</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#idp47890928">3. Programming the 8051 with SDCC</a></span></dt><dd><dl><dt><span class="section"><a href="#idp47893024">1. 8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#idp47894960">1.1. __data</a></span></dt><dt><span class="section"><a href="#idp47897136">1.2. __idata</a></span></dt><dt><span class="section"><a href="#idp47898576">1.3. __xdata</a></span></dt><dt><span class="section"><a href="#idp47899984">1.4. __pdata</a></span></dt><dt><span class="section"><a href="#idp47901488">1.5. __code</a></span></dt><dt><span class="section"><a href="#idp47902928">1.6. __bit</a></span></dt><dt><span class="section"><a href="#idp47904432">1.7. __sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#idp47905968">2. Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#idp47907440">2.1. __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp47909632">2.2. Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp47911776">2.3. __interrupt functions</a></span></dt><dt><span class="section"><a href="#idp47913344">2.4. __critical functions and statements</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#idp47915408">4. Task functions</a></span></dt><dd><dl><dt><span class="section"><a href="#idp47916464">1. ao_add_task</a></span></dt><dt><span class="section"><a href="#idp47918720">2. ao_exit</a></span></dt><dt><span class="section"><a href="#idp53787440">3. ao_sleep</a></span></dt><dt><span class="section"><a href="#idp53791040">4. ao_wakeup</a></span></dt><dt><span class="section"><a href="#idp53794032">5. ao_alarm</a></span></dt><dt><span class="section"><a href="#idp53797312">6. ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#idp53799280">7. ao_clock_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp53801248">5. Timer Functions</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53802752">1. ao_time</a></span></dt><dt><span class="section"><a href="#idp53804736">2. ao_delay</a></span></dt><dt><span class="section"><a href="#idp53806576">3. ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#idp53808624">4. ao_timer_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp53810816">6. AltOS Mutexes</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53812688">1. ao_mutex_get</a></span></dt><dt><span class="section"><a href="#idp53814528">2. ao_mutex_put</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp53816496">7. DMA engine</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53819936">1. CC1111 DMA Engine</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53820608">1.1. ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#idp53822784">1.2. ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#idp53825056">1.3. ao_dma_start</a></span></dt><dt><span class="section"><a href="#idp53827072">1.4. ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#idp53828912">1.5. ao_dma_abort</a></span></dt></dl></dd><dt><span class="section"><a href="#idp53831056">2. STM32L DMA Engine</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53831728">2.1. ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#idp53833568">2.2. ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#idp53835824">2.3. ao_dma_set_isr</a></span></dt><dt><span class="section"><a href="#idp53837904">2.4. ao_dma_start</a></span></dt><dt><span class="section"><a href="#idp53840208">2.5. ao_dma_done_transfer</a></span></dt><dt><span class="section"><a href="#idp53842192">2.6. ao_dma_abort</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#idp53844464">8. Stdio interface</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53845968">1. putchar</a></span></dt><dt><span class="section"><a href="#idp53847856">2. getchar</a></span></dt><dt><span class="section"><a href="#idp53849952">3. flush</a></span></dt><dt><span class="section"><a href="#idp53851984">4. ao_add_stdio</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp53856016">9. Command line interface</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53857424">1. ao_cmd_register</a></span></dt><dt><span class="section"><a href="#idp53866064">2. ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#idp53868144">3. ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#idp53869984">4. ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#idp53871872">5. ao_cmd_white</a></span></dt><dt><span class="section"><a href="#idp53873936">6. ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#idp53875984">7. ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#idp53878080">8. ao_match_word</a></span></dt><dt><span class="section"><a href="#idp53880160">9. ao_cmd_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp53882384">10. USB target device</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53884608">1. ao_usb_flush</a></span></dt><dt><span class="section"><a href="#idp53886752">2. ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#idp53888928">3. ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#idp53891072">4. ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#idp53893088">5. ao_usb_disable</a></span></dt><dt><span class="section"><a href="#idp53895920">6. ao_usb_enable</a></span></dt><dt><span class="section"><a href="#idp53898032">7. ao_usb_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp53900256">11. Serial peripherals</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53902272">1. ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#idp53904304">2. ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#idp53906272">3. ao_serial_drain</a></span></dt><dt><span class="section"><a href="#idp53908272">4. ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#idp53910304">5. ao_serial_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp53912496">12. CC1111 Radio peripheral</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53913168">1. Radio Introduction</a></span></dt><dt><span class="section"><a href="#idp53920288">2. ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#idp53922448">3. ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#idp53924608">4. ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#idp53926848">5. ao_radio_idle</a></span></dt><dt><span class="section"><a href="#idp53928896">6. ao_radio_get</a></span></dt><dt><span class="section"><a href="#idp53930928">7. ao_radio_put</a></span></dt><dt><span class="section"><a href="#idp53932864">8. ao_radio_abort</a></span></dt><dt><span class="section"><a href="#idp53934928">9. Radio Telemetry</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53936224">9.1. ao_radio_send</a></span></dt><dt><span class="section"><a href="#idp53938448">9.2. ao_radio_recv</a></span></dt></dl></dd><dt><span class="section"><a href="#idp53940912">10. Radio Direction Finding</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53942064">10.1. ao_radio_rdf</a></span></dt></dl></dd><dt><span class="section"><a href="#idp53944208">11. Radio Packet Mode</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53945520">11.1. ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#idp53947696">11.2. ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#idp53949776">11.3. ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#idp53951728">11.4. ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#idp53953648">11.5. ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#idp53955680">11.6. ao_packet_master_init</a></span></dt></dl></dd></dl></dd></dl></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp47884288"></a>Chapter 1. Overview</h1></div></div></div><p>
+ </p></div></div><div><div class="revhistory"><table style="border-style:solid; width:100%;" summary="Revision History"><tr><th align="left" valign="top" colspan="2"><b>Revision History</b></th></tr><tr><td align="left">Revision 1.1</td><td align="left">05 November 2012</td></tr><tr><td align="left" colspan="2">Portable version</td></tr><tr><td align="left">Revision 0.1</td><td align="left">22 November 2010</td></tr><tr><td align="left" colspan="2">Initial content</td></tr></table></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="chapter"><a href="#idp47882736">1. Overview</a></span></dt><dt><span class="chapter"><a href="#idp48914816">2. AltOS Porting Layer</a></span></dt><dd><dl><dt><span class="section"><a href="#idp48916320">1. Low-level CPU operations</a></span></dt><dd><dl><dt><span class="section"><a href="#idp48917552">1.1. ao_arch_block_interrupts/ao_arch_release_interrupts</a></span></dt><dt><span class="section"><a href="#idp48919600">1.2. ao_arch_save_regs, ao_arch_save_stack,
+ ao_arch_restore_stack</a></span></dt><dt><span class="section"><a href="#idp4
8052384">1.3. ao_arch_wait_interupt</a></span></dt></dl></dd><dt><span class="section"><a href="#idp48054928">2. GPIO operations</a></span></dt><dd><dl><dt><span class="section"><a href="#idp48056096">2.1. GPIO setup</a></span></dt><dt><span class="section"><a href="#idp48065040">2.2. Reading and writing GPIO pins</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#idp47889248">3. Programming the 8051 with SDCC</a></span></dt><dd><dl><dt><span class="section"><a href="#idp47891344">1. 8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#idp47893280">1.1. __data</a></span></dt><dt><span class="section"><a href="#idp47895456">1.2. __idata</a></span></dt><dt><span class="section"><a href="#idp47896896">1.3. __xdata</a></span></dt><dt><span class="section"><a href="#idp47898304">1.4. __pdata</a></span></dt><dt><span class="section"><a href="#idp47899808">1.5. __code</a></span></dt><dt><span class="section"><a href="#idp47901248">1.6. __bit</a></span></dt><dt><span class="section"><a href="#idp47902752">1.7. __sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#idp47904288">2. Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#idp47905760">2.1. __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp47907952">2.2. Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp47910096">2.3. __interrupt functions</a></span></dt><dt><span class="section"><a href="#idp47911664">2.4. __critical functions and statements</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#idp47913728">4. Task functions</a></span></dt><dd><dl><dt><span class="section"><a href="#idp47914784">1. ao_add_task</a></span></dt><dt><span class="section"><a href="#idp47917040">2. ao_exit</a></span></dt><dt><span class="section"><a href="#idp54330432">3. ao_sleep</a></span></dt><dt><span class="section"><a href="#idp54334032">4. ao_wakeup</a></span></dt><dt><span class="section"><a href="#idp54337024">5. ao_alarm</a></span></dt><dt><span class="section"><a href="#idp54340304">6. ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#idp54342272">7. ao_clock_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp54344240">5. Timer Functions</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54345744">1. ao_time</a></span></dt><dt><span class="section"><a href="#idp54347728">2. ao_delay</a></span></dt><dt><span class="section"><a href="#idp54349568">3. ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#idp54351616">4. ao_timer_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp54353808">6. AltOS Mutexes</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54355680">1. ao_mutex_get</a></span></dt><dt><span class="section"><a href="#idp54357520">2. ao_mutex_put</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp54359488">7. DMA engine</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54362928">1. CC1111 DMA Engine</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54363600">1.1. ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#idp54365776">1.2. ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#idp54368048">1.3. ao_dma_start</a></span></dt><dt><span class="section"><a href="#idp54370064">1.4. ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#idp54371904">1.5. ao_dma_abort</a></span></dt></dl></dd><dt><span class="section"><a href="#idp54374048">2. STM32L DMA Engine</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54374720">2.1. ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#idp54376560">2.2. ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#idp54378816">2.3. ao_dma_set_isr</a></span></dt><dt><span class="section"><a href="#idp54380896">2.4. ao_dma_start</a></span></dt><dt><span class="section"><a href="#idp54383200">2.5. ao_dma_done_transfer</a></span></dt><dt><span class="section"><a href="#idp54385184">2.6. ao_dma_abort</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#idp54387456">8. Stdio interface</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54388960">1. putchar</a></span></dt><dt><span class="section"><a href="#idp54390848">2. getchar</a></span></dt><dt><span class="section"><a href="#idp54392944">3. flush</a></span></dt><dt><span class="section"><a href="#idp54394976">4. ao_add_stdio</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp54398928">9. Command line interface</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54400336">1. ao_cmd_register</a></span></dt><dt><span class="section"><a href="#idp54408896">2. ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#idp54410976">3. ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#idp54412816">4. ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#idp54414704">5. ao_cmd_white</a></span></dt><dt><span class="section"><a href="#idp54416768">6. ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#idp54418816">7. ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#idp54420912">8. ao_match_word</a></span></dt><dt><span class="section"><a href="#idp54422992">9. ao_cmd_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp54425216">10. USB target device</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54427440">1. ao_usb_flush</a></span></dt><dt><span class="section"><a href="#idp54429584">2. ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#idp54431760">3. ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#idp54433904">4. ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#idp54435920">5. ao_usb_disable</a></span></dt><dt><span class="section"><a href="#idp54438752">6. ao_usb_enable</a></span></dt><dt><span class="section"><a href="#idp54440864">7. ao_usb_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp54443088">11. Serial peripherals</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54445104">1. ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#idp54447136">2. ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#idp54449104">3. ao_serial_drain</a></span></dt><dt><span class="section"><a href="#idp54451104">4. ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#idp54453136">5. ao_serial_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp54455328">12. CC1111 Radio peripheral</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54456000">1. Radio Introduction</a></span></dt><dt><span class="section"><a href="#idp54463120">2. ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#idp54465280">3. ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#idp54467440">4. ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#idp54469680">5. ao_radio_idle</a></span></dt><dt><span class="section"><a href="#idp54471728">6. ao_radio_get</a></span></dt><dt><span class="section"><a href="#idp54473760">7. ao_radio_put</a></span></dt><dt><span class="section"><a href="#idp54475696">8. ao_radio_abort</a></span></dt><dt><span class="section"><a href="#idp54477760">9. Radio Telemetry</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54479056">9.1. ao_radio_send</a></span></dt><dt><span class="section"><a href="#idp54481280">9.2. ao_radio_recv</a></span></dt></dl></dd><dt><span class="section"><a href="#idp54483744">10. Radio Direction Finding</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54484896">10.1. ao_radio_rdf</a></span></dt></dl></dd><dt><span class="section"><a href="#idp54487040">11. Radio Packet Mode</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54488352">11.1. ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#idp54490528">11.2. ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#idp54492608">11.3. ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#idp54494560">11.4. ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#idp54496480">11.5. ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#idp54498512">11.6. ao_packet_master_init</a></span></dt></dl></dd></dl></dd></dl></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp47882736"></a>Chapter 1. Overview</h1></div></div></div><p>
AltOS is a operating system built for a variety of
microcontrollers used in Altus Metrum devices. It has a simple
porting layer for each CPU while providing a convenient
</pre><p>
As you can see, a long sequence of subsystems are initialized
and then the scheduler is started.
- </p></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp48916512"></a>Chapter 2. AltOS Porting Layer</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp48918016">1. Low-level CPU operations</a></span></dt><dd><dl><dt><span class="section"><a href="#idp48919248">1.1. ao_arch_block_interrupts/ao_arch_release_interrupts</a></span></dt><dt><span class="section"><a href="#idp48921296">1.2. ao_arch_save_regs, ao_arch_save_stack,
- ao_arch_restore_stack</a></span></dt><dt><span class="section"><a href="#idp4
9830960">1.3. ao_arch_wait_interupt</a></span></dt></dl></dd><dt><span class="section"><a href="#idp49833504">2. GPIO operations</a></span></dt><dd><dl><dt><span class="section"><a href="#idp49834672">2.1. GPIO setup</a></span></dt><dt><span class="section"><a href="#idp49843888">2.2. Reading and writing GPIO pins</a></span></dt></dl></dd></dl></div><p>
+ </p></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp48914816"></a>Chapter 2. AltOS Porting Layer</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp48916320">1. Low-level CPU operations</a></span></dt><dd><dl><dt><span class="section"><a href="#idp48917552">1.1. ao_arch_block_interrupts/ao_arch_release_interrupts</a></span></dt><dt><span class="section"><a href="#idp48919600">1.2. ao_arch_save_regs, ao_arch_save_stack,
+ ao_arch_restore_stack</a></span></dt><dt><span class="section"><a href="#idp4
8052384">1.3. ao_arch_wait_interupt</a></span></dt></dl></dd><dt><span class="section"><a href="#idp48054928">2. GPIO operations</a></span></dt><dd><dl><dt><span class="section"><a href="#idp48056096">2.1. GPIO setup</a></span></dt><dt><span class="section"><a href="#idp48065040">2.2. Reading and writing GPIO pins</a></span></dt></dl></dd></dl></div><p>
AltOS provides a CPU-independent interface to various common
microcontroller subsystems, including GPIO pins, interrupts,
SPI, I2C, USB and asynchronous serial interfaces. By making
application code can all be written that work on any supported
CPU. Many of the architecture abstraction interfaces are
prefixed with ao_arch.
- </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp4891
8016"></a>1. Low-level CPU operations</h2></div></div></div><p>
+ </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp4891
6320"></a>1. Low-level CPU operations</h2></div></div></div><p>
These primitive operations provide the abstraction needed to
run the multi-tasking framework while providing reliable
interrupt delivery.
- </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4891
9248"></a>1.1. ao_arch_block_interrupts/ao_arch_release_interrupts</h3></div></div></div><pre class="programlisting">
+ </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4891
7552"></a>1.1. ao_arch_block_interrupts/ao_arch_release_interrupts</h3></div></div></div><pre class="programlisting">
static inline void
ao_arch_block_interrupts(void);
discard any interrupts. Use these for sections of code that
must be atomic with respect to any code run from an
interrupt handler.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp48921296"></a>1.2. ao_arch_save_regs, ao_arch_save_stack,
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp48919600"></a>1.2. ao_arch_save_regs, ao_arch_save_stack,
ao_arch_restore_stack</h3></div></div></div><pre class="programlisting">
static inline void
ao_arch_save_regs(void);
in the current ao_task structure. ao_arch_restore_stack
switches back to the saved stack, restores all registers and
branches to the saved return address.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4
9830960"></a>1.3. ao_arch_wait_interupt</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4
8052384"></a>1.3. ao_arch_wait_interupt</h3></div></div></div><pre class="programlisting">
#define ao_arch_wait_interrupt()
</pre><p>
This stops the CPU, leaving clocks and interrupts
disable interrupts again. If the CPU doesn't have any
reduced power mode, this must at the least allow pending
interrupts to be processed.
- </p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp4
9833504"></a>2. GPIO operations</h2></div></div></div><p>
+ </p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp4
8054928"></a>2. GPIO operations</h2></div></div></div><p>
These functions provide an abstract interface to configure and
manipulate GPIO pins.
- </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4
9834672"></a>2.1. GPIO setup</h3></div></div></div><p>
+ </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4
8056096"></a>2.1. GPIO setup</h3></div></div></div><p>
These macros may be invoked at system initialization time to
configure pins as needed for system operation. One tricky
aspect is that some chips provide direct access to specific
provide both port+bit and pin arguments. Simply define the
arguments needed for the target platform and leave the
others undefined.
- </p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="idp4892
3152"></a>2.1.1. ao_enable_output</h4></div></div></div><pre class="programlisting">
+ </p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="idp4892
1456"></a>2.1.1. ao_enable_output</h4></div></div></div><pre class="programlisting">
#define ao_enable_output(port, bit, pin, value)
</pre><p>
Set the specified port+bit (also called 'pin') for output,
initializing to the specified value. The macro must avoid
driving the pin with the opposite value if at all
possible.
- </p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="idp4
9838448"></a>2.1.2. ao_enable_input</h4></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="idp4
8059744"></a>2.1.2. ao_enable_input</h4></div></div></div><pre class="programlisting">
#define ao_enable_input(port, bit, mode)
</pre><p>
Sets the specified port/bit to be an input pin. 'mode' is
0. Don't apply either a pull-up or pull-down. A
disconnected pin will read an undetermined value.
</p></li></ul></div><p>
- </p></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4
9843888"></a>2.2. Reading and writing GPIO pins</h3></div></div></div><p>
+ </p></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4
8065040"></a>2.2. Reading and writing GPIO pins</h3></div></div></div><p>
These macros read and write individual GPIO pins.
- </p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="idp4
9844960"></a>2.2.1. ao_gpio_set</h4></div></div></div><pre class="programlisting">
+ </p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="idp4
8066112"></a>2.2.1. ao_gpio_set</h4></div></div></div><pre class="programlisting">
#define ao_gpio_set(port, bit, pin, value)
</pre><p>
Sets the specified port/bit or pin to the indicated value
- </p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="idp4
7888592"></a>2.2.2. ao_gpio_get</h4></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="idp4
8067952"></a>2.2.2. ao_gpio_get</h4></div></div></div><pre class="programlisting">
#define ao_gpio_get(port, bit, pin)
</pre><p>
Returns either 1 or 0 depending on whether the input to
the pin is high or low.
- </p></div></div></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp478
90928"></a>Chapter 3. Programming the 8051 with SDCC</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp47893024">1. 8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#idp47894960">1.1. __data</a></span></dt><dt><span class="section"><a href="#idp47897136">1.2. __idata</a></span></dt><dt><span class="section"><a href="#idp47898576">1.3. __xdata</a></span></dt><dt><span class="section"><a href="#idp47899984">1.4. __pdata</a></span></dt><dt><span class="section"><a href="#idp47901488">1.5. __code</a></span></dt><dt><span class="section"><a href="#idp47902928">1.6. __bit</a></span></dt><dt><span class="section"><a href="#idp47904432">1.7. __sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#idp47905968">2. Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#idp47907440">2.1. __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp47909632">2.2. Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp47911776">2.3. __interrupt functions</a></span></dt><dt><span class="section"><a href="#idp47913344">2.4. __critical functions and statements</a></span></dt></dl></dd></dl></div><p>
+ </p></div></div></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp478
89248"></a>Chapter 3. Programming the 8051 with SDCC</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp47891344">1. 8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#idp47893280">1.1. __data</a></span></dt><dt><span class="section"><a href="#idp47895456">1.2. __idata</a></span></dt><dt><span class="section"><a href="#idp47896896">1.3. __xdata</a></span></dt><dt><span class="section"><a href="#idp47898304">1.4. __pdata</a></span></dt><dt><span class="section"><a href="#idp47899808">1.5. __code</a></span></dt><dt><span class="section"><a href="#idp47901248">1.6. __bit</a></span></dt><dt><span class="section"><a href="#idp47902752">1.7. __sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#idp47904288">2. Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#idp47905760">2.1. __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp47907952">2.2. Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp47910096">2.3. __interrupt functions</a></span></dt><dt><span class="section"><a href="#idp47911664">2.4. __critical functions and statements</a></span></dt></dl></dd></dl></div><p>
The 8051 is a primitive 8-bit processor, designed in the mists
of time in as few transistors as possible. The architecture is
highly irregular and includes several separate memory
</p><p>
When built on other architectures, the various SDCC-specific
symbols are #defined as empty strings so they don't affect the compiler.
- </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp4789
3024"></a>1. 8051 memory spaces</h2></div></div></div><p>
+ </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp4789
1344"></a>1. 8051 memory spaces</h2></div></div></div><p>
The __data/__xdata/__code memory spaces below were completely
separate in the original 8051 design. In the cc1111, this
isn't true—they all live in a single unified 64kB address
is decorated with a memory space identifier which clutters the
code but makes the resulting code far smaller and more
efficient.
- </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4789
4960"></a>1.1. __data</h3></div></div></div><p>
+ </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4789
3280"></a>1.1. __data</h3></div></div></div><p>
The 8051 can directly address these 128 bytes of
memory. This makes them precious so they should be
reserved for frequently addressed values. Oh, just to
these registers located at 0x00 - 0x1F. AltOS uses only
the first bank at 0x00 - 0x07, leaving the other 24
bytes available for other data.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4789
7136"></a>1.2. __idata</h3></div></div></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4789
5456"></a>1.2. __idata</h3></div></div></div><p>
There are an additional 128 bytes of internal memory
that share the same address space as __data but which
cannot be directly addressed. The stack normally
occupies this space and so AltOS doesn't place any
static storage here.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4789
8576"></a>1.3. __xdata</h3></div></div></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4789
6896"></a>1.3. __xdata</h3></div></div></div><p>
This is additional general memory accessed through a
single 16-bit address register. The CC1111F32 has 32kB
of memory available here. Most program data should live
in this memory space.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4789
9984"></a>1.4. __pdata</h3></div></div></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4789
8304"></a>1.4. __pdata</h3></div></div></div><p>
This is an alias for the first 256 bytes of __xdata
memory, but uses a shorter addressing mode with
single global 8-bit value for the high 8 bits of the
address and any of several 8-bit registers for the low 8
bits. AltOS uses a few bits of this memory, it should
probably use more.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp47
901488"></a>1.5. __code</h3></div></div></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp47
899808"></a>1.5. __code</h3></div></div></div><p>
All executable code must live in this address space, but
you can stick read-only data here too. It is addressed
using the 16-bit address register and special 'code'
access opcodes. Anything read-only should live in this space.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4790
2928"></a>1.6. __bit</h3></div></div></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4790
1248"></a>1.6. __bit</h3></div></div></div><p>
The 8051 has 128 bits of bit-addressible memory that
lives in the __data segment from 0x20 through
0x2f. Special instructions access these bits
in a single atomic operation. This isn't so much a
separate address space as a special addressing mode for
a few bytes in the __data segment.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4790
4432"></a>1.7. __sfr, __sfr16, __sfr32, __sbit</h3></div></div></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4790
2752"></a>1.7. __sfr, __sfr16, __sfr32, __sbit</h3></div></div></div><p>
Access to physical registers in the device use this mode
which declares the variable name, it's type and the
address it lives at. No memory is allocated for these
variables.
- </p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp4790
5968"></a>2. Function calls on the 8051</h2></div></div></div><p>
+ </p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp4790
4288"></a>2. Function calls on the 8051</h2></div></div></div><p>
Because stack addressing is expensive, and stack space
limited, the default function call declaration in SDCC
allocates all parameters and local variables in static global
non-reentrant, and also consume space for parameters and
locals even when they are not running. The benefit is smaller
code and faster execution.
- </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4790
7440"></a>2.1. __reentrant functions</h3></div></div></div><p>
+ </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4790
5760"></a>2.1. __reentrant functions</h3></div></div></div><p>
All functions which are re-entrant, either due to recursion
or due to a potential context switch while executing, should
be marked as __reentrant so that their parameters and local
invoked can also be marked as __reentrant. The resulting
code will be larger, but the savings in memory are
frequently worthwhile.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4790
9632"></a>2.2. Non __reentrant functions</h3></div></div></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4790
7952"></a>2.2. Non __reentrant functions</h3></div></div></div><p>
All parameters and locals in non-reentrant functions can
have data space decoration so that they are allocated in
__xdata, __pdata or __data space as desired. This can avoid
non-reentrant. Because of this, interrupt handlers must not
invoke any library functions, including the multiply and
divide code.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4791
1776"></a>2.3. __interrupt functions</h3></div></div></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4791
0096"></a>2.3. __interrupt functions</h3></div></div></div><p>
Interrupt functions are declared with with an __interrupt
decoration that includes the interrupt number. SDCC saves
and restores all of the registers in these functions and
uses the 'reti' instruction at the end so that they operate
as stand-alone interrupt handlers. Interrupt functions may
call the ao_wakeup function to wake AltOS tasks.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4791
3344"></a>2.4. __critical functions and statements</h3></div></div></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp4791
1664"></a>2.4. __critical functions and statements</h3></div></div></div><p>
SDCC has built-in support for suspending interrupts during
critical code. Functions marked as __critical will have
interrupts suspended for the whole period of
quickly as possible. AltOS doesn't use this form in shared
code as other compilers wouldn't know what to do. Use
ao_arch_block_interrupts and ao_arch_release_interrupts instead.
- </p></div></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp4791
5408"></a>Chapter 4. Task functions</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp47916464">1. ao_add_task</a></span></dt><dt><span class="section"><a href="#idp47918720">2. ao_exit</a></span></dt><dt><span class="section"><a href="#idp53787440">3. ao_sleep</a></span></dt><dt><span class="section"><a href="#idp53791040">4. ao_wakeup</a></span></dt><dt><span class="section"><a href="#idp53794032">5. ao_alarm</a></span></dt><dt><span class="section"><a href="#idp53797312">6. ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#idp53799280">7. ao_clock_init</a></span></dt></dl></div><p>
+ </p></div></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp4791
3728"></a>Chapter 4. Task functions</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp47914784">1. ao_add_task</a></span></dt><dt><span class="section"><a href="#idp47917040">2. ao_exit</a></span></dt><dt><span class="section"><a href="#idp54330432">3. ao_sleep</a></span></dt><dt><span class="section"><a href="#idp54334032">4. ao_wakeup</a></span></dt><dt><span class="section"><a href="#idp54337024">5. ao_alarm</a></span></dt><dt><span class="section"><a href="#idp54340304">6. ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#idp54342272">7. ao_clock_init</a></span></dt></dl></div><p>
This chapter documents how to create, destroy and schedule AltOS tasks.
- </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp4791
6464"></a>1. ao_add_task</h2></div></div></div><pre class="programlisting">
+ </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp4791
4784"></a>1. ao_add_task</h2></div></div></div><pre class="programlisting">
void
ao_add_task(__xdata struct ao_task * task,
void (*start)(void),
display), and the start address. It does not switch to the
new task. 'start' must not ever return; there is no place
to return to.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp4791
8720"></a>2. ao_exit</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp4791
7040"></a>2. ao_exit</h2></div></div></div><pre class="programlisting">
void
ao_exit(void)
</pre><p>
This terminates the current task.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3787440"></a>3. ao_sleep</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4330432"></a>3. ao_sleep</h2></div></div></div><pre class="programlisting">
void
ao_sleep(__xdata void *wchan)
</pre><p>
ao_sleep(&ao_radio_done);
ao_arch_release_interrupts();
</pre><p>
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3791040"></a>4. ao_wakeup</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4334032"></a>4. ao_wakeup</h2></div></div></div><pre class="programlisting">
void
ao_wakeup(__xdata void *wchan)
</pre><p>
Note that this need not block interrupts as the ao_sleep block
can only be run from normal mode, and so this sequence can
never be interrupted with execution of the other sequence.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3794032"></a>5. ao_alarm</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4337024"></a>5. ao_alarm</h2></div></div></div><pre class="programlisting">
void
ao_alarm(uint16_t delay);
incoming radio data. If no data is received before the
timeout fires, ao_sleep will return 1 and then this code
will abort the radio receive operation.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3797312"></a>6. ao_start_scheduler</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4340304"></a>6. ao_start_scheduler</h2></div></div></div><pre class="programlisting">
void
ao_start_scheduler(void);
</pre><p>
This is called from 'main' when the system is all
initialized and ready to run. It will not return.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3799280"></a>7. ao_clock_init</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4342272"></a>7. ao_clock_init</h2></div></div></div><pre class="programlisting">
void
ao_clock_init(void);
</pre><p>
This initializes the main CPU clock and switches to it.
- </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
3801248"></a>Chapter 5. Timer Functions</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp53802752">1. ao_time</a></span></dt><dt><span class="section"><a href="#idp53804736">2. ao_delay</a></span></dt><dt><span class="section"><a href="#idp53806576">3. ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#idp53808624">4. ao_timer_init</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
4344240"></a>Chapter 5. Timer Functions</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp54345744">1. ao_time</a></span></dt><dt><span class="section"><a href="#idp54347728">2. ao_delay</a></span></dt><dt><span class="section"><a href="#idp54349568">3. ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#idp54351616">4. ao_timer_init</a></span></dt></dl></div><p>
AltOS sets up one of the CPU timers to run at 100Hz and
exposes this tick as the fundemental unit of time. At each
interrupt, AltOS increments the counter, and schedules any tasks
collect current data readings. Doing this from the ISR ensures
that the values are sampled at a regular rate, independent
of any scheduling jitter.
- </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3802752"></a>1. ao_time</h2></div></div></div><pre class="programlisting">
+ </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4345744"></a>1. ao_time</h2></div></div></div><pre class="programlisting">
uint16_t
ao_time(void)
</pre><p>
Returns the current system tick count. Note that this is
only a 16 bit value, and so it wraps every 655.36 seconds.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3804736"></a>2. ao_delay</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4347728"></a>2. ao_delay</h2></div></div></div><pre class="programlisting">
void
ao_delay(uint16_t ticks);
</pre><p>
Suspend the current task for at least 'ticks' clock units.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3806576"></a>3. ao_timer_set_adc_interval</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4349568"></a>3. ao_timer_set_adc_interval</h2></div></div></div><pre class="programlisting">
void
ao_timer_set_adc_interval(uint8_t interval);
</pre><p>
This sets the number of ticks between ADC samples. If set
to 0, no ADC samples are generated. AltOS uses this to
slow down the ADC sampling rate to save power.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3808624"></a>4. ao_timer_init</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4351616"></a>4. ao_timer_init</h2></div></div></div><pre class="programlisting">
void
ao_timer_init(void)
</pre><p>
This turns on the 100Hz tick. It is required for any of the
time-based functions to work. It should be called by 'main'
before ao_start_scheduler.
- </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
3810816"></a>Chapter 6. AltOS Mutexes</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp53812688">1. ao_mutex_get</a></span></dt><dt><span class="section"><a href="#idp53814528">2. ao_mutex_put</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
4353808"></a>Chapter 6. AltOS Mutexes</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp54355680">1. ao_mutex_get</a></span></dt><dt><span class="section"><a href="#idp54357520">2. ao_mutex_put</a></span></dt></dl></div><p>
AltOS provides mutexes as a basic synchronization primitive. Each
mutexes is simply a byte of memory which holds 0 when the mutex
is free or the task id of the owning task when the mutex is
owned. Mutex calls are checked—attempting to acquire a mutex
already held by the current task or releasing a mutex not held
by the current task will both cause a panic.
- </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3812688"></a>1. ao_mutex_get</h2></div></div></div><pre class="programlisting">
+ </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4355680"></a>1. ao_mutex_get</h2></div></div></div><pre class="programlisting">
void
ao_mutex_get(__xdata uint8_t *mutex);
</pre><p>
Acquires the specified mutex, blocking if the mutex is
owned by another task.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3814528"></a>2. ao_mutex_put</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4357520"></a>2. ao_mutex_put</h2></div></div></div><pre class="programlisting">
void
ao_mutex_put(__xdata uint8_t *mutex);
</pre><p>
Releases the specified mutex, waking up all tasks waiting
for it.
- </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
3816496"></a>Chapter 7. DMA engine</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp53819936">1. CC1111 DMA Engine</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53820608">1.1. ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#idp53822784">1.2. ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#idp53825056">1.3. ao_dma_start</a></span></dt><dt><span class="section"><a href="#idp53827072">1.4. ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#idp53828912">1.5. ao_dma_abort</a></span></dt></dl></dd><dt><span class="section"><a href="#idp53831056">2. STM32L DMA Engine</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53831728">2.1. ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#idp53833568">2.2. ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#idp53835824">2.3. ao_dma_set_isr</a></span></dt><dt><span class="section"><a href="#idp53837904">2.4. ao_dma_start</a></span></dt><dt><span class="section"><a href="#idp53840208">2.5. ao_dma_done_transfer</a></span></dt><dt><span class="section"><a href="#idp53842192">2.6. ao_dma_abort</a></span></dt></dl></dd></dl></div><p>
+ </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
4359488"></a>Chapter 7. DMA engine</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp54362928">1. CC1111 DMA Engine</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54363600">1.1. ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#idp54365776">1.2. ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#idp54368048">1.3. ao_dma_start</a></span></dt><dt><span class="section"><a href="#idp54370064">1.4. ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#idp54371904">1.5. ao_dma_abort</a></span></dt></dl></dd><dt><span class="section"><a href="#idp54374048">2. STM32L DMA Engine</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54374720">2.1. ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#idp54376560">2.2. ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#idp54378816">2.3. ao_dma_set_isr</a></span></dt><dt><span class="section"><a href="#idp54380896">2.4. ao_dma_start</a></span></dt><dt><span class="section"><a href="#idp54383200">2.5. ao_dma_done_transfer</a></span></dt><dt><span class="section"><a href="#idp54385184">2.6. ao_dma_abort</a></span></dt></dl></dd></dl></div><p>
The CC1111 and STM32L both contain a useful bit of extra
hardware in the form of a number of programmable DMA
engines. They can be configured to copy data in memory, or
from hardware to memory, that trigger event is supplied by the
hardware device. When copying data from memory to hardware, the
transfer is usually initiated by software.
- </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3819936"></a>1. CC1111 DMA Engine</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp53820608"></a>1.1. ao_dma_alloc</h3></div></div></div><pre class="programlisting">
+ </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4362928"></a>1. CC1111 DMA Engine</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp54363600"></a>1.1. ao_dma_alloc</h3></div></div></div><pre class="programlisting">
uint8_t
ao_dma_alloc(__xdata uint8_t *done)
</pre><p>
AO_DMA_ABORTED bit if ao_dma_abort was called. Note that it
is possible to get both bits if the transfer was aborted
after it had finished.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3822784"></a>1.2. ao_dma_set_transfer</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4365776"></a>1.2. ao_dma_set_transfer</h3></div></div></div><pre class="programlisting">
void
ao_dma_set_transfer(uint8_t id,
void __xdata *srcaddr,
cfg1 are values directly out of the CC1111 documentation
and tell the DMA engine what the transfer unit size,
direction and step are.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3825056"></a>1.3. ao_dma_start</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4368048"></a>1.3. ao_dma_start</h3></div></div></div><pre class="programlisting">
void
ao_dma_start(uint8_t id);
</pre><p>
Arm the specified DMA engine and await a signal from
either hardware or software to start transferring data.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3827072"></a>1.4. ao_dma_trigger</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4370064"></a>1.4. ao_dma_trigger</h3></div></div></div><pre class="programlisting">
void
ao_dma_trigger(uint8_t id)
</pre><p>
Trigger the specified DMA engine to start copying data.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3828912"></a>1.5. ao_dma_abort</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4371904"></a>1.5. ao_dma_abort</h3></div></div></div><pre class="programlisting">
void
ao_dma_abort(uint8_t id)
</pre><p>
Terminate any in-progress DMA transation, marking its
'done' variable with the AO_DMA_ABORTED bit.
- </p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3831056"></a>2. STM32L DMA Engine</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp53831728"></a>2.1. ao_dma_alloc</h3></div></div></div><pre class="programlisting">
+ </p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4374048"></a>2. STM32L DMA Engine</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp54374720"></a>2.1. ao_dma_alloc</h3></div></div></div><pre class="programlisting">
uint8_t ao_dma_done[];
void
</pre><p>
Reserve a DMA engine for exclusive use by one
driver.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3833568"></a>2.2. ao_dma_set_transfer</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4376560"></a>2.2. ao_dma_set_transfer</h3></div></div></div><pre class="programlisting">
void
ao_dma_set_transfer(uint8_t id,
void *peripheral,
value directly out of the STM32L documentation and tells the
DMA engine what the transfer unit size, direction and step
are.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3835824"></a>2.3. ao_dma_set_isr</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4378816"></a>2.3. ao_dma_set_isr</h3></div></div></div><pre class="programlisting">
void
ao_dma_set_isr(uint8_t index, void (*isr)(int))
</pre><p>
completes in lieu of setting the ao_dma_done bits. Use this
when some work needs to be done when the DMA finishes that
cannot wait until user space resumes.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3837904"></a>2.4. ao_dma_start</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4380896"></a>2.4. ao_dma_start</h3></div></div></div><pre class="programlisting">
void
ao_dma_start(uint8_t id);
</pre><p>
or the AO_DMA_ABORTED bit if ao_dma_abort was called. Note
that it is possible to get both bits if the transfer was
aborted after it had finished.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3840208"></a>2.5. ao_dma_done_transfer</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4383200"></a>2.5. ao_dma_done_transfer</h3></div></div></div><pre class="programlisting">
void
ao_dma_done_transfer(uint8_t id);
</pre><p>
Signals that a specific DMA engine is done being used. This
allows multiple drivers to use the same DMA engine safely.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3842192"></a>2.6. ao_dma_abort</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4385184"></a>2.6. ao_dma_abort</h3></div></div></div><pre class="programlisting">
void
ao_dma_abort(uint8_t id)
</pre><p>
Terminate any in-progress DMA transation, marking its
'done' variable with the AO_DMA_ABORTED bit.
- </p></div></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
3844464"></a>Chapter 8. Stdio interface</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp53845968">1. putchar</a></span></dt><dt><span class="section"><a href="#idp53847856">2. getchar</a></span></dt><dt><span class="section"><a href="#idp53849952">3. flush</a></span></dt><dt><span class="section"><a href="#idp53851984">4. ao_add_stdio</a></span></dt></dl></div><p>
+ </p></div></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
4387456"></a>Chapter 8. Stdio interface</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp54388960">1. putchar</a></span></dt><dt><span class="section"><a href="#idp54390848">2. getchar</a></span></dt><dt><span class="section"><a href="#idp54392944">3. flush</a></span></dt><dt><span class="section"><a href="#idp54394976">4. ao_add_stdio</a></span></dt></dl></div><p>
AltOS offers a stdio interface over USB, serial and the RF
packet link. This provides for control of the device localy or
remotely. This is hooked up to the stdio functions by providing
automatically multiplex the available communication channels;
output is always delivered to the channel which provided the
most recent input.
- </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3845968"></a>1. putchar</h2></div></div></div><pre class="programlisting">
+ </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4388960"></a>1. putchar</h2></div></div></div><pre class="programlisting">
void
putchar(char c)
</pre><p>
Delivers a single character to the current console
device.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3847856"></a>2. getchar</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4390848"></a>2. getchar</h2></div></div></div><pre class="programlisting">
char
getchar(void)
</pre><p>
console devices. The current console device is set to
that which delivered this character. This blocks until
a character is available.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3849952"></a>3. flush</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4392944"></a>3. flush</h2></div></div></div><pre class="programlisting">
void
flush(void)
</pre><p>
Flushes the current console device output buffer. Any
pending characters will be delivered to the target device.
- xo </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3851984"></a>4. ao_add_stdio</h2></div></div></div><pre class="programlisting">
+ xo </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4394976"></a>4. ao_add_stdio</h2></div></div></div><pre class="programlisting">
void
ao_add_stdio(char (*pollchar)(void),
void (*putchar)(char),
'flush' forces the output buffer to be flushed. It may
block until the buffer is delivered, but it is not
required to do so.
- </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
3856016"></a>Chapter 9. Command line interface</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp53857424">1. ao_cmd_register</a></span></dt><dt><span class="section"><a href="#idp53866064">2. ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#idp53868144">3. ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#idp53869984">4. ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#idp53871872">5. ao_cmd_white</a></span></dt><dt><span class="section"><a href="#idp53873936">6. ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#idp53875984">7. ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#idp53878080">8. ao_match_word</a></span></dt><dt><span class="section"><a href="#idp53880160">9. ao_cmd_init</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
4398928"></a>Chapter 9. Command line interface</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp54400336">1. ao_cmd_register</a></span></dt><dt><span class="section"><a href="#idp54408896">2. ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#idp54410976">3. ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#idp54412816">4. ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#idp54414704">5. ao_cmd_white</a></span></dt><dt><span class="section"><a href="#idp54416768">6. ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#idp54418816">7. ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#idp54420912">8. ao_match_word</a></span></dt><dt><span class="section"><a href="#idp54422992">9. ao_cmd_init</a></span></dt></dl></div><p>
AltOS includes a simple command line parser which is hooked up
to the stdio interfaces permitting remote control of the device
over USB, serial or the RF link as desired. Each command uses a
single character to invoke it, the remaining characters on the
line are available as parameters to the command.
- </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3857424"></a>1. ao_cmd_register</h2></div></div></div><pre class="programlisting">
+ </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4400336"></a>1. ao_cmd_register</h2></div></div></div><pre class="programlisting">
void
ao_cmd_register(__code struct ao_cmds *cmds)
</pre><p>
The command line is invalid for some reason other
than invalid tokens.
</p></dd></dl></div><p>
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3866064"></a>2. ao_cmd_lex</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4408896"></a>2. ao_cmd_lex</h2></div></div></div><pre class="programlisting">
void
ao_cmd_lex(void);
</pre><p>
This gets the next character out of the command line
buffer and sticks it into ao_cmd_lex_c. At the end of the
line, ao_cmd_lex_c will get a newline ('\n') character.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3868144"></a>3. ao_cmd_put16</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4410976"></a>3. ao_cmd_put16</h2></div></div></div><pre class="programlisting">
void
ao_cmd_put16(uint16_t v);
</pre><p>
Writes 'v' as four hexadecimal characters.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3869984"></a>4. ao_cmd_put8</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4412816"></a>4. ao_cmd_put8</h2></div></div></div><pre class="programlisting">
void
ao_cmd_put8(uint8_t v);
</pre><p>
Writes 'v' as two hexadecimal characters.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3871872"></a>5. ao_cmd_white</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4414704"></a>5. ao_cmd_white</h2></div></div></div><pre class="programlisting">
void
ao_cmd_white(void)
</pre><p>
This skips whitespace by calling ao_cmd_lex while
ao_cmd_lex_c is either a space or tab. It does not skip
any characters if ao_cmd_lex_c already non-white.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3873936"></a>6. ao_cmd_hex</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4416768"></a>6. ao_cmd_hex</h2></div></div></div><pre class="programlisting">
void
ao_cmd_hex(void)
</pre><p>
This reads a 16-bit hexadecimal value from the command
line with optional leading whitespace. The resulting value
is stored in ao_cmd_lex_i;
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3875984"></a>7. ao_cmd_decimal</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4418816"></a>7. ao_cmd_decimal</h2></div></div></div><pre class="programlisting">
void
ao_cmd_decimal(void)
</pre><p>
line with optional leading whitespace. The resulting value
is stored in ao_cmd_lex_u32 and the low 16 bits are stored
in ao_cmd_lex_i;
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3878080"></a>8. ao_match_word</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4420912"></a>8. ao_match_word</h2></div></div></div><pre class="programlisting">
uint8_t
ao_match_word(__code char *word)
</pre><p>
line. It does not skip leading white space. If 'word' is
found, then 1 is returned. Otherwise, ao_cmd_status is set to
ao_cmd_syntax_error and 0 is returned.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3880160"></a>9. ao_cmd_init</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4422992"></a>9. ao_cmd_init</h2></div></div></div><pre class="programlisting">
void
ao_cmd_init(void
</pre><p>
Initializes the command system, setting up the built-in
commands and adding a task to run the command processing
loop. It should be called by 'main' before ao_start_scheduler.
- </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
3882384"></a>Chapter 10. USB target device</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp53884608">1. ao_usb_flush</a></span></dt><dt><span class="section"><a href="#idp53886752">2. ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#idp53888928">3. ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#idp53891072">4. ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#idp53893088">5. ao_usb_disable</a></span></dt><dt><span class="section"><a href="#idp53895920">6. ao_usb_enable</a></span></dt><dt><span class="section"><a href="#idp53898032">7. ao_usb_init</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
4425216"></a>Chapter 10. USB target device</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp54427440">1. ao_usb_flush</a></span></dt><dt><span class="section"><a href="#idp54429584">2. ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#idp54431760">3. ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#idp54433904">4. ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#idp54435920">5. ao_usb_disable</a></span></dt><dt><span class="section"><a href="#idp54438752">6. ao_usb_enable</a></span></dt><dt><span class="section"><a href="#idp54440864">7. ao_usb_init</a></span></dt></dl></div><p>
AltOS contains a full-speed USB target device driver. It can be
programmed to offer any kind of USB target, but to simplify
interactions with a variety of operating systems, AltOS provides
interface if desired, offering control of the device over the
USB link. Alternatively, the functions can be accessed directly
to provide for USB-specific I/O.
- </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3884608"></a>1. ao_usb_flush</h2></div></div></div><pre class="programlisting">
+ </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4427440"></a>1. ao_usb_flush</h2></div></div></div><pre class="programlisting">
void
ao_usb_flush(void);
</pre><p>
to be delivered to the USB host if there is pending data,
or if the last IN packet was full to indicate to the host
that there isn't any more pending data available.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3886752"></a>2. ao_usb_putchar</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4429584"></a>2. ao_usb_putchar</h2></div></div></div><pre class="programlisting">
void
ao_usb_putchar(char c);
</pre><p>
adds a byte to the pending IN packet for delivery to the
USB host. If the USB packet is full, this queues the 'IN'
packet for delivery.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3888928"></a>3. ao_usb_pollchar</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4431760"></a>3. ao_usb_pollchar</h2></div></div></div><pre class="programlisting">
char
ao_usb_pollchar(void);
</pre><p>
packet received, this returns AO_READ_AGAIN. Otherwise, it
returns the next character, reporting to the host that it
is ready for more data when the last character is gone.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3891072"></a>4. ao_usb_getchar</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4433904"></a>4. ao_usb_getchar</h2></div></div></div><pre class="programlisting">
char
ao_usb_getchar(void);
</pre><p>
This uses ao_pollchar to receive the next character,
blocking while ao_pollchar returns AO_READ_AGAIN.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3893088"></a>5. ao_usb_disable</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4435920"></a>5. ao_usb_disable</h2></div></div></div><pre class="programlisting">
void
ao_usb_disable(void);
</pre><p>
after disabling the USB device, it's likely that the cable
will need to be disconnected and reconnected before it
will work again.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3895920"></a>6. ao_usb_enable</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4438752"></a>6. ao_usb_enable</h2></div></div></div><pre class="programlisting">
void
ao_usb_enable(void);
</pre><p>
disabled. See the note above about needing to physically
remove and re-insert the cable to get the host to
re-initialize the USB link.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3898032"></a>7. ao_usb_init</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4440864"></a>7. ao_usb_init</h2></div></div></div><pre class="programlisting">
void
ao_usb_init(void);
</pre><p>
the control end point and adds the usb I/O functions to
the stdio system. Call this from main before
ao_start_scheduler.
- </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
3900256"></a>Chapter 11. Serial peripherals</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp53902272">1. ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#idp53904304">2. ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#idp53906272">3. ao_serial_drain</a></span></dt><dt><span class="section"><a href="#idp53908272">4. ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#idp53910304">5. ao_serial_init</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
4443088"></a>Chapter 11. Serial peripherals</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp54445104">1. ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#idp54447136">2. ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#idp54449104">3. ao_serial_drain</a></span></dt><dt><span class="section"><a href="#idp54451104">4. ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#idp54453136">5. ao_serial_init</a></span></dt></dl></div><p>
The CC1111 provides two USART peripherals. AltOS uses one for
asynch serial data, generally to communicate with a GPS device,
and the other for a SPI bus. The UART is configured to operate
</p><p>
To prevent loss of data, AltOS provides receive and transmit
fifos of 32 characters each.
- </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3902272"></a>1. ao_serial_getchar</h2></div></div></div><pre class="programlisting">
+ </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4445104"></a>1. ao_serial_getchar</h2></div></div></div><pre class="programlisting">
char
ao_serial_getchar(void);
</pre><p>
Returns the next character from the receive fifo, blocking
until a character is received if the fifo is empty.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3904304"></a>2. ao_serial_putchar</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4447136"></a>2. ao_serial_putchar</h2></div></div></div><pre class="programlisting">
void
ao_serial_putchar(char c);
</pre><p>
Adds a character to the transmit fifo, blocking if the
fifo is full. Starts transmitting characters.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3906272"></a>3. ao_serial_drain</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4449104"></a>3. ao_serial_drain</h2></div></div></div><pre class="programlisting">
void
ao_serial_drain(void);
</pre><p>
Blocks until the transmit fifo is empty. Used internally
when changing serial speeds.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3908272"></a>4. ao_serial_set_speed</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4451104"></a>4. ao_serial_set_speed</h2></div></div></div><pre class="programlisting">
void
ao_serial_set_speed(uint8_t speed);
</pre><p>
AO_SERIAL_SPEED_4800, AO_SERIAL_SPEED_9600 or
AO_SERIAL_SPEED_57600. This first flushes the transmit
fifo using ao_serial_drain.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3910304"></a>5. ao_serial_init</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4453136"></a>5. ao_serial_init</h2></div></div></div><pre class="programlisting">
void
ao_serial_init(void)
</pre><p>
Initializes the serial peripheral. Call this from 'main'
before jumping to ao_start_scheduler. The default speed
setting is AO_SERIAL_SPEED_4800.
- </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
3912496"></a>Chapter 12. CC1111 Radio peripheral</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp53913168">1. Radio Introduction</a></span></dt><dt><span class="section"><a href="#idp53920288">2. ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#idp53922448">3. ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#idp53924608">4. ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#idp53926848">5. ao_radio_idle</a></span></dt><dt><span class="section"><a href="#idp53928896">6. ao_radio_get</a></span></dt><dt><span class="section"><a href="#idp53930928">7. ao_radio_put</a></span></dt><dt><span class="section"><a href="#idp53932864">8. ao_radio_abort</a></span></dt><dt><span class="section"><a href="#idp53934928">9. Radio Telemetry</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53936224">9.1. ao_radio_send</a></span></dt><dt><span class="section"><a href="#idp53938448">9.2. ao_radio_recv</a></span></dt></dl></dd><dt><span class="section"><a href="#idp53940912">10. Radio Direction Finding</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53942064">10.1. ao_radio_rdf</a></span></dt></dl></dd><dt><span class="section"><a href="#idp53944208">11. Radio Packet Mode</a></span></dt><dd><dl><dt><span class="section"><a href="#idp53945520">11.1. ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#idp53947696">11.2. ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#idp53949776">11.3. ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#idp53951728">11.4. ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#idp53953648">11.5. ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#idp53955680">11.6. ao_packet_master_init</a></span></dt></dl></dd></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp53913168"></a>1. Radio Introduction</h2></div></div></div><p>
+ </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp5
4455328"></a>Chapter 12. CC1111 Radio peripheral</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idp54456000">1. Radio Introduction</a></span></dt><dt><span class="section"><a href="#idp54463120">2. ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#idp54465280">3. ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#idp54467440">4. ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#idp54469680">5. ao_radio_idle</a></span></dt><dt><span class="section"><a href="#idp54471728">6. ao_radio_get</a></span></dt><dt><span class="section"><a href="#idp54473760">7. ao_radio_put</a></span></dt><dt><span class="section"><a href="#idp54475696">8. ao_radio_abort</a></span></dt><dt><span class="section"><a href="#idp54477760">9. Radio Telemetry</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54479056">9.1. ao_radio_send</a></span></dt><dt><span class="section"><a href="#idp54481280">9.2. ao_radio_recv</a></span></dt></dl></dd><dt><span class="section"><a href="#idp54483744">10. Radio Direction Finding</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54484896">10.1. ao_radio_rdf</a></span></dt></dl></dd><dt><span class="section"><a href="#idp54487040">11. Radio Packet Mode</a></span></dt><dd><dl><dt><span class="section"><a href="#idp54488352">11.1. ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#idp54490528">11.2. ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#idp54492608">11.3. ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#idp54494560">11.4. ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#idp54496480">11.5. ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#idp54498512">11.6. ao_packet_master_init</a></span></dt></dl></dd></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp54456000"></a>1. Radio Introduction</h2></div></div></div><p>
The CC1111 radio transceiver sends and receives digital packets
with forward error correction and detection. The AltOS driver is
fairly specific to the needs of the TeleMetrum and TeleDongle
receiver. This is designed to provide a beacon to track
the device when other location mechanisms fail.
</p></li></ol></div><p>
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3920288"></a>2. ao_radio_set_telemetry</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4463120"></a>2. ao_radio_set_telemetry</h2></div></div></div><pre class="programlisting">
void
ao_radio_set_telemetry(void);
</pre><p>
other RF parameters. It does not include the base frequency
or channel though. Those are set at the time of transmission
or reception, in case the values are changed by the user.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3922448"></a>3. ao_radio_set_packet</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4465280"></a>3. ao_radio_set_packet</h2></div></div></div><pre class="programlisting">
void
ao_radio_set_packet(void);
</pre><p>
parameters. It does not include the base frequency or
channel though. Those are set at the time of transmission or
reception, in case the values are changed by the user.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3924608"></a>4. ao_radio_set_rdf</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4467440"></a>4. ao_radio_set_rdf</h2></div></div></div><pre class="programlisting">
void
ao_radio_set_rdf(void);
</pre><p>
and data whitening logic is turned off so that the resulting
modulation is received as a 1kHz tone by a conventional 70cm
FM audio receiver.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3926848"></a>5. ao_radio_idle</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4469680"></a>5. ao_radio_idle</h2></div></div></div><pre class="programlisting">
void
ao_radio_idle(void);
</pre><p>
Sets the radio device to idle mode, waiting until it reaches
that state. This will terminate any in-progress transmit or
receive operation.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3928896"></a>6. ao_radio_get</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4471728"></a>6. ao_radio_get</h2></div></div></div><pre class="programlisting">
void
ao_radio_get(void);
</pre><p>
Acquires the radio mutex and then configures the radio
frequency using the global radio calibration and channel
values.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3930928"></a>7. ao_radio_put</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4473760"></a>7. ao_radio_put</h2></div></div></div><pre class="programlisting">
void
ao_radio_put(void);
</pre><p>
Releases the radio mutex.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3932864"></a>8. ao_radio_abort</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4475696"></a>8. ao_radio_abort</h2></div></div></div><pre class="programlisting">
void
ao_radio_abort(void);
</pre><p>
Aborts any transmission or reception process by aborting the
associated DMA object and calling ao_radio_idle to terminate
the radio operation.
- </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3934928"></a>9. Radio Telemetry</h2></div></div></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4477760"></a>9. Radio Telemetry</h2></div></div></div><p>
In telemetry mode, you can send or receive a telemetry
packet. The data from receiving a packet also includes the RSSI
and status values supplied by the receiver. These are added
after the telemetry data.
- </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3936224"></a>9.1. ao_radio_send</h3></div></div></div><pre class="programlisting">
+ </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4479056"></a>9.1. ao_radio_send</h3></div></div></div><pre class="programlisting">
void
ao_radio_send(__xdata struct ao_telemetry *telemetry);
</pre><p>
telemetry mode. This function calls ao_radio_get() before
sending, and ao_radio_put() afterwards, to correctly
serialize access to the radio device.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3938448"></a>9.2. ao_radio_recv</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4481280"></a>9.2. ao_radio_recv</h3></div></div></div><pre class="programlisting">
void
ao_radio_recv(__xdata struct ao_radio_recv *radio);
</pre><p>
to the radio device. This returns non-zero if a packet was
received, or zero if the operation was aborted (from some
other task calling ao_radio_abort()).
- </p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3940912"></a>10. Radio Direction Finding</h2></div></div></div><p>
+ </p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4483744"></a>10. Radio Direction Finding</h2></div></div></div><p>
In radio direction finding mode, there's just one function to
use
- </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3942064"></a>10.1. ao_radio_rdf</h3></div></div></div><pre class="programlisting">
+ </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4484896"></a>10.1. ao_radio_rdf</h3></div></div></div><pre class="programlisting">
void
ao_radio_rdf(int ms);
</pre><p>
This sends an RDF packet lasting for the specified amount
of time. The maximum length is 1020 ms.
- </p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
3944208"></a>11. Radio Packet Mode</h2></div></div></div><p>
+ </p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp5
4487040"></a>11. Radio Packet Mode</h2></div></div></div><p>
Packet mode is asymmetrical and is configured at compile time
for either master or slave mode (but not both). The basic I/O
functions look the same at both ends, but the internals are
different, along with the initialization steps.
- </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3945520"></a>11.1. ao_packet_putchar</h3></div></div></div><pre class="programlisting">
+ </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4488352"></a>11.1. ao_packet_putchar</h3></div></div></div><pre class="programlisting">
void
ao_packet_putchar(char c);
</pre><p>
transmit a packet if the output buffer is full. On the
slave side, any pending data will be sent the next time
the master polls for data.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3947696"></a>11.2. ao_packet_pollchar</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4490528"></a>11.2. ao_packet_pollchar</h3></div></div></div><pre class="programlisting">
char
ao_packet_pollchar(void);
</pre><p>
This returns a pending input character if available,
otherwise returns AO_READ_AGAIN. On the master side, if
this empties the buffer, it triggers a poll for more data.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3949776"></a>11.3. ao_packet_slave_start</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4492608"></a>11.3. ao_packet_slave_start</h3></div></div></div><pre class="programlisting">
void
ao_packet_slave_start(void);
</pre><p>
This is available only on the slave side and starts a task
to listen for packet data.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3951728"></a>11.4. ao_packet_slave_stop</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4494560"></a>11.4. ao_packet_slave_stop</h3></div></div></div><pre class="programlisting">
void
ao_packet_slave_stop(void);
</pre><p>
Disables the packet slave task, stopping the radio receiver.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3953648"></a>11.5. ao_packet_slave_init</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4496480"></a>11.5. ao_packet_slave_init</h3></div></div></div><pre class="programlisting">
void
ao_packet_slave_init(void);
</pre><p>
Adds the packet stdio functions to the stdio package so
that when packet slave mode is enabled, characters will
get send and received through the stdio functions.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
3955680"></a>11.6. ao_packet_master_init</h3></div></div></div><pre class="programlisting">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idp5
4498512"></a>11.6. ao_packet_master_init</h3></div></div></div><pre class="programlisting">
void
ao_packet_master_init(void);
</pre><p>
projects / web / altusmetrum / blobdiff