summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGregory Nutt <gnutt@nuttx.org>2014-03-31 17:25:39 -0600
committerGregory Nutt <gnutt@nuttx.org>2014-03-31 17:25:39 -0600
commita38c6df093edba13268a94fffcf4534cce5bc7d6 (patch)
tree4f65275cfdf3b20ef861fb1a3c15e6da42085830
parentc7a9660fcda133175e2121d7414de362d2ae00c1 (diff)
downloadnuttx-a38c6df093edba13268a94fffcf4534cce5bc7d6.tar.gz
nuttx-a38c6df093edba13268a94fffcf4534cce5bc7d6.tar.bz2
nuttx-a38c6df093edba13268a94fffcf4534cce5bc7d6.zip
Cosmetic update to comments and README files
-rw-r--r--nuttx/arch/arm/src/sama5/Kconfig6
-rw-r--r--nuttx/arch/arm/src/sama5/chip/sam_uart.h14
-rw-r--r--nuttx/configs/sama5d3-xplained/README.txt73
-rw-r--r--nuttx/configs/sama5d3x-ek/README.txt6
4 files changed, 34 insertions, 65 deletions
diff --git a/nuttx/arch/arm/src/sama5/Kconfig b/nuttx/arch/arm/src/sama5/Kconfig
index 17808ebe6..4e1b0a1c3 100644
--- a/nuttx/arch/arm/src/sama5/Kconfig
+++ b/nuttx/arch/arm/src/sama5/Kconfig
@@ -108,15 +108,15 @@ endchoice # Atmel AT91SAMA5 Chip Selection
menu "SAMA5 Peripheral Support"
config SAMA5_DBGU
- bool "Debug Unit Interrupt (DBGU)"
+ bool "Debug Unit (DBGU)"
default n
config SAMA5_PIT
- bool "Periodic Interval Timer Interrupt (PIT)"
+ bool "Periodic Interval Timer (PIT)"
default n
config SAMA5_WDT
- bool "Watchdog timer Interrupt (WDT)"
+ bool "Watchdog timer (WDT)"
default n
select WATCHDOG
diff --git a/nuttx/arch/arm/src/sama5/chip/sam_uart.h b/nuttx/arch/arm/src/sama5/chip/sam_uart.h
index b2e781c08..832e13089 100644
--- a/nuttx/arch/arm/src/sama5/chip/sam_uart.h
+++ b/nuttx/arch/arm/src/sama5/chip/sam_uart.h
@@ -1,9 +1,9 @@
/************************************************************************************************
- * arch/arm/src/sam34/chip/sam3u_uart.h
+ * arch/arm/src/sama5/chip/sam3u_uart.h
* Universal Asynchronous Receiver Transmitter (UART) and Universal Synchronous Asynchronous
- * Receiver Transmitter (USART) definitions for the SAM3U, SAM3X, SAM3A and SAM4S
+ * Receiver Transmitter (USART) definitions for the SAMA5D3
*
- * Copyright (C) 2009, 2013 Gregory Nutt. All rights reserved.
+ * Copyright (C) 2013 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
@@ -35,8 +35,8 @@
*
************************************************************************************************/
-#ifndef __ARCH_ARM_SRC_SAM34_CHIP_SAM3U_UART_H
-#define __ARCH_ARM_SRC_SAM34_CHIP_SAM3U_UART_H
+#ifndef __ARCH_ARM_SRC_SAMA5_CHIP_SAM_UART_H
+#define __ARCH_ARM_SRC_SAMA5_CHIP_SAM_UART_H
/************************************************************************************************
* Included Files
@@ -200,7 +200,7 @@
#define UART_CR_RSTSTA (1 << 8) /* Bit 8: Reset Status Bits (Common) */
#define UART_CR_STTBRK (1 << 9) /* Bit 9: Start Break (USART UART mode only) */
#define UART_CR_STPBRK (1 << 10) /* Bit 10: Stop Break (USART UART mode only) */
-#define UART_CR_STTTO (1 << 11) /* Bit 11: Start Time-out (USART oUART mode nly) */
+#define UART_CR_STTTO (1 << 11) /* Bit 11: Start Time-out (USART UART mode only) */
#define UART_CR_SENDA (1 << 12) /* Bit 12: Send Address (USART UART mode only) */
#define UART_CR_RSTIT (1 << 13) /* Bit 13: Reset Iterations (USART UART mode only) */
#define UART_CR_RSTNACK (1 << 14) /* Bit 14: Reset Non Acknowledge (USART UART mode only) */
@@ -407,4 +407,4 @@
* Public Functions
************************************************************************************************/
-#endif /* __ARCH_ARM_SRC_SAM34_CHIP_SAM3U_UART_H */
+#endif /* __ARCH_ARM_SRC_SAMA5_CHIP_SAM_UART_H */
diff --git a/nuttx/configs/sama5d3-xplained/README.txt b/nuttx/configs/sama5d3-xplained/README.txt
index ed547a2bb..507cf43b2 100644
--- a/nuttx/configs/sama5d3-xplained/README.txt
+++ b/nuttx/configs/sama5d3-xplained/README.txt
@@ -662,9 +662,7 @@ Serial Console
By default USART1 is used as the NuttX serial console in all
configurations (unless otherwise noted). USART1 is provided at TTL
- levels at pins TXD0 and TXD1 or J20.
-
- USART1 Connector J8
+ levels at pins TXD0 and TXD1 of J20.
DBGU Interface
--------------
@@ -2528,7 +2526,7 @@ Configurations
reconfiguration process.
2. Unless stated otherwise, all configurations generate console
- output on UART0 (J3).
+ output on USART1 (J20).
3. All of these configurations use the Code Sourcery for Windows toolchain
(unless stated otherwise in the description of the configuration). That
@@ -2609,61 +2607,56 @@ Configurations
the warning in the section "Information Common to All Configurations"
for further information.
- 3. This configuration executes out of NAND flash and can only
- be loaded via BareBox.
+ 3. This configuration executes out of SDRAM flash and is loaded into
+ SDRAM from NAND, Serial DataFlash, or from a TFTPC sever via
+ U-Boot or BareBox. Data also is positioned in SDRAM.
4. This configuration has support for NSH built-in applications enabled.
However, no built-in applications are selected in the base configuration.
- 5. Data resides in ISRAM, but can be moved to SDRAM as described above
- under "SDRAM Data Configuration."
-
- 6. This configuration has support for the FAT file system built in. However,
+ 5. This configuration has support for the FAT file system built in. However,
by default, there are no block drivers initialized. The FAT file system can
still be used to create RAM disks.
- 7. SDRAM support can be enabled by modifying your NuttX configuration as
- described above in the paragraph entitle "SDRAM Support"
-
- 8. The SAMA5D3 Xplained board includes an option serial DataFlash. Support
+ 6. The SAMA5D3 Xplained board includes an option serial DataFlash. Support
for that serial FLASH can be enabled by modifying the NuttX configuration
as described above in the paragraph entitled "AT25 Serial FLASH".
- 9. Enabling HSMCI support. The SAMA5D3-Xplained provides a two SD memory
+ 7. Enabling HSMCI support. The SAMA5D3-Xplained provides a two SD memory
card slots: (1) a full size SD card slot (J10), and (2) a microSD
memory card slot (J11). The full size SD card slot connects via HSMCI0;
the microSD connects vi HSMCI1. Support for both SD slots can be enabled
with the settings provided in the paragraph entitled "HSMCI Card Slots"
above.
- 10. Support the USB low-, high- and full-speed OHCI host driver can be enabled
- by changing the NuttX configuration file as described in the section
- entitled "USB High-Speed Host" above.
+ 8. Support the USB low-, high- and full-speed OHCI host driver can be enabled
+ by changing the NuttX configuration file as described in the section
+ entitled "USB High-Speed Host" above.
- 11. Support the USB high-speed USB device driver (UDPHS) can be enabled
- by changing the NuttX configuration file as described above in the
- section entitled "USB High-Speed Device."
+ 9. Support the USB high-speed USB device driver (UDPHS) can be enabled
+ by changing the NuttX configuration file as described above in the
+ section entitled "USB High-Speed Device."
- 12. I2C Tool. NuttX supports an I2C tool at apps/system/i2c that can be
+ 10. I2C Tool. NuttX supports an I2C tool at apps/system/i2c that can be
used to peek and poke I2C devices. See the discussion above under
"I2C Tool" for detailed configuration settings.
- 13. Networking support via the can be added to NSH by modifying the
+ 11. Networking support via the can be added to NSH by modifying the
configuration. See the "Networking" section above for detailed
configuration settings.
- 16. The Real Time Clock/Calendar RTC) may be enabled by reconfiguring NuttX.
+ 12. The Real Time Clock/Calendar (RTC) may be enabled by reconfiguring NuttX.
See the section entitled "RTC" above for detailed configuration settings.
- 17. This example can be configured to exercise the watchdog timer test
+ 13. This example can be configured to exercise the watchdog timer test
(apps/examples/watchdog). See the detailed configuration settings in
the section entitled "Watchdog Timer" above.
- 18. This example can be configured to enable the SAMA5 TRNG peripheral so
+ 14. This example can be configured to enable the SAMA5 TRNG peripheral so
that it provides /dev/random. See the section entitled "TRNG and
/dev/random" above for detailed configuration information.
- 19. See also the sections above for additional configuration options:
+ 16. See also the sections above for additional configuration options:
"CAN Usage", "SAMA5 ADC Support", "SAMA5 PWM Support", "I2S Audio
Support"
@@ -2691,29 +2684,5 @@ To-Do List
3) HSCMI TX DMA support is currently commented out.
-4) I believe that there is an issue when the internal AT25 FLASH is
- formatted by NuttX. That format works fine with Linux, but does not
- appear to work with Windows. Reformatting on Windows can resolve this.
- NOTE: This is not a SAMA5Dx issue.
-
- UPDATE: Two important bugs were recently fixed in the NuttX FAT
- formatting function (mkfatfs). It is likely that these fixes will
- eliminate this issue, but that has not yet been verified.
-
-5) CAN testing has not yet been performed due to issues with cabling. I
- just do not have a good test bed (or sufficient CAN knowledge) for
- good CAN testing.
-
-6) The NxWM example does not work well. This example was designed to work
- with much smaller displays and does not look good or work well with the
- SAMA5D3-Xplained's 800x480 display. See above for details.
-
-7) I have a Camera, but there is still no ISI driver. I am not sure what to
- do with the camera. NuttX needs something like V4L to provide the
- definition for what a camera driver is supposed to do.
-
- I will probably develop a test harness for ISI, but it is of only
- minimal value with no OS infrastructure to deal with images and video.
-
-8) GMAC has only been tested on a 10/100Base-T network. I don't have a
+7) GMAC has only been tested on a 10/100Base-T network. I don't have a
1000Base-T network to support additional testing.
diff --git a/nuttx/configs/sama5d3x-ek/README.txt b/nuttx/configs/sama5d3x-ek/README.txt
index 54f4fbb10..15bb9adf2 100644
--- a/nuttx/configs/sama5d3x-ek/README.txt
+++ b/nuttx/configs/sama5d3x-ek/README.txt
@@ -2857,7 +2857,7 @@ Configurations
reconfiguration process.
2. Unless stated otherwise, all configurations generate console
- output on UART0 (J3).
+ output on USART1 (J8).
3. All of these configurations use the Code Sourcery for Windows toolchain
(unless stated otherwise in the description of the configuration). That
@@ -2979,7 +2979,7 @@ Configurations
Relevant configuration settings are provided in the paragraph entitled
"SDRAM Support" above.
- 6. The Real Time Clock/Calendar RTC) is enabled. See the section entitled
+ 6. The Real Time Clock/Calendar (RTC) is enabled. See the section entitled
"RTC" above.
7. The Embest or Ronetix CPU module includes an Atmel AT25DF321A,
@@ -3170,7 +3170,7 @@ Configurations
configuration instrcutions in the section entitled "Touchscreen
Testing" above.
- 16. The Real Time Clock/Calendar RTC) may be enabled by reconfiguring NuttX.
+ 16. The Real Time Clock/Calendar (RTC) may be enabled by reconfiguring NuttX.
See the section entitled "RTC" above for detailed configuration settings.
17. This example can be configured to exercise the watchdog timer test