From eb7e66c945e3b82ccc0217aed5d4ac36aa429faf Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Mon, 18 May 2015 13:41:35 -0600 Subject: [PATCH] Update Documentation --- ChangeLog | 4 ++++ Documentation/NuttX.html | 27 ++++++++++++++++++++-- Documentation/NuttxPortingGuide.html | 34 +++++++++++++++++++++++++++- Documentation/NuttxUserGuide.html | 31 ------------------------- include/nuttx/wdog.h | 2 +- 5 files changed, 63 insertions(+), 35 deletions(-) diff --git a/ChangeLog b/ChangeLog index 2c22847b9f..4b6fd89be8 100755 --- a/ChangeLog +++ b/ChangeLog @@ -10393,3 +10393,7 @@ signal/sig_timed*.c, timer/timer_settime.c, and wdog/wd_start.c: Update the type passed to watchdog timer handlers. Using uint32_t is a problem for 64-bit machines (2015-05-18). + * configs/saml21-xplained: Add a board build configuration for the + SAML21 Xplained Pro. Initial commit is just the SAMD20 Xplained Pro + board support with naming changed. Does not yet build (2015-05-18). + diff --git a/Documentation/NuttX.html b/Documentation/NuttX.html index 83716155a6..236c5d6d19 100644 --- a/Documentation/NuttX.html +++ b/Documentation/NuttX.html @@ -8,7 +8,7 @@

NuttX RTOS

-

Last Updated: May 1, 2015

+

Last Updated: May 18, 2015

@@ -1330,7 +1330,7 @@
  • ARM926EJS (4)
  • ARM Cortex-A5 (2)
  • ARM Cortex-A8 (1)
    • -
  • ARM Cortex-M0/M0+ (4)
    • +
  • ARM Cortex-M0/M0+ (5)
  • ARM Cortex-M3 (32)
  • ARM Cortex-M4 (20)
  • ARM Cortex-M7 (1)
    • @@ -1402,6 +1402,7 @@
  • AVR AT90USB64x and AT90USB6128x (8-bit AVR)
  • AVR32 AT32UC3BXXX (32-bit AVR32)
  • Atmel SAMD20 (ARM Cortex-M0+)
    • +
  • Atmel SAML21 (ARM Cortex-M0+)
  • Atmel SAM3U (ARM Cortex-M3)
  • Atmel SAM3X (ARM Cortex-M3)
  • Atmel SAM4C (ARM Cortex-M4)
    • @@ -2229,6 +2230,28 @@ nsh> + +
    +
    + + +
    + +

    + Atmel SAML21. + The port of NuttX to the Atmel SAML21-Xplained Pro development board. + This board features the ATSAML21J18A MCU (Cortex-M0+ with 256KB of FLASH and 32KB of SRAM). +

    + + + diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html index 9712eb01de..2f6fbaf601 100644 --- a/Documentation/NuttxPortingGuide.html +++ b/Documentation/NuttxPortingGuide.html @@ -12,7 +12,7 @@

    NuttX RTOS Porting Guide

    -

    Last Updated: April 1, 2015

    +

    Last Updated: May 18, 2015

    @@ -2725,6 +2725,8 @@ int up_timer_start(FAR const struct timespec *ts);
  • 4.3.5.3 wd_start
  • 4.3.5.4 wd_cancel
  • 4.3.5.5 wd_gettime
    • +
  • 4.3.5.6 Watchdog Timer Callback
    • +

    4.3.5.1 wd_create/wd_static

    @@ -2927,6 +2929,36 @@ VxWorks provides the following comparable interface: means either that wdog is not valid or that the wdog has already expired.

    +

    4.3.5.6 Watchdog Timer Callback

    +

    + When a watchdog expires, the callback function with this type is called: +

    +
    +    typedef void (*wdentry_t)(int argc, ...);
+
    +

    + Where argc is the number of wdparm_t type arguments that follow. +

    +

    + The arguments are passed as scalar wdparm_t values. For systems where the sizeof(pointer) < sizeof(uint32_t), the following union defines the alignment of the pointer within the uint32_t. For example, the SDCC MCS51 general pointer is 24-bits, but uint32_t is 32-bits (of course). +

    + We always have sizeof(pointer) <= sizeof(uintptr_t) by definition. +

    + +

    4.4 Work Queues

    Work Queues. NuttX provides work queues. Work queues are threads the service a queue of work items to be performed. There are useful for off-loading work to a different threading context, for delayed processing, or for serializing activities. diff --git a/Documentation/NuttxUserGuide.html b/Documentation/NuttxUserGuide.html index 26079b5752..4e028ae0bd 100644 --- a/Documentation/NuttxUserGuide.html +++ b/Documentation/NuttxUserGuide.html @@ -9731,37 +9731,6 @@ notify a task when a message is available on a queue. }; -

    3.4.9 Watchdog Data Types

    - -

    - When a watchdog expires, the callback function with this - type is called: -

    -
    -    typedef void (*wdentry_t)(int argc, ...);
-
    -

    - Where argc is the number of uint32_t type arguments that follow. -

    -

    - The arguments are passed as wdparm_t values. For systems where the sizeof(pointer) < sizeof(uint32_t), the following union defines the alignment of the pointer within the uint32_t. For example, the SDCC MCS51 general pointer is 24-bits, but uint32_t is 32-bits (of course). -

    - We always have sizeof(pointer) <= sizeof(uintptr_t) by definitions. -

    - diff --git a/include/nuttx/wdog.h b/include/nuttx/wdog.h index 44774cd850..aefcadf662 100644 --- a/include/nuttx/wdog.h +++ b/include/nuttx/wdog.h @@ -106,7 +106,7 @@ * alignment of the pointer within the uint32_t. For example, the SDCC * MCS51 general pointer is 24-bits, but uint32_t is 32-bits (of course). * - * We always have sizeof(pointer) <= sizeof(uintptr_t) by definitions. + * We always have sizeof(pointer) <= sizeof(uintptr_t) by definition. */ union wdparm_u