summaryrefslogtreecommitdiff
path: root/nuttx/configs/pic32mx7mmb/README.txt
diff options
context:
space:
mode:
authorGregory Nutt <gnutt@nuttx.org>2014-03-01 12:00:56 -0600
committerGregory Nutt <gnutt@nuttx.org>2014-03-01 12:00:56 -0600
commitd9a83782704fb7781c378d53f71f1296bb17c77d (patch)
tree3c94a1310d5f160d7f1d8dc5c3834d7786b3cf1a /nuttx/configs/pic32mx7mmb/README.txt
parent6e012713da02fb88bdae7745721d95d76ef7ea57 (diff)
downloadpx4-nuttx-d9a83782704fb7781c378d53f71f1296bb17c77d.tar.gz
px4-nuttx-d9a83782704fb7781c378d53f71f1296bb17c77d.tar.bz2
px4-nuttx-d9a83782704fb7781c378d53f71f1296bb17c77d.zip
configs/pic32mx7mmb/nsh converted to use the kconfig-frontends tools
Diffstat (limited to 'nuttx/configs/pic32mx7mmb/README.txt')
-rw-r--r--nuttx/configs/pic32mx7mmb/README.txt302
1 files changed, 148 insertions, 154 deletions
diff --git a/nuttx/configs/pic32mx7mmb/README.txt b/nuttx/configs/pic32mx7mmb/README.txt
index a3098313c..7e02b901b 100644
--- a/nuttx/configs/pic32mx7mmb/README.txt
+++ b/nuttx/configs/pic32mx7mmb/README.txt
@@ -610,215 +610,209 @@ selected as follow:
Where <subdir> is one of the following:
nsh:
- ====
- Description.
- ------------
+
This is the NuttShell (NSH) using the NSH startup logic at
apps/examples/nsh.
- Serial Output.
- --------------
- The OS test produces all of its test output on the serial console.
- This configuration has UART1 enabled as a serial console.
+ NOTES:
+
+ 1. This configuration uses the mconf-based configuration tool. To
+ change this configurations using that tool, you should:
+
+ a. Build and install the kconfig-mconf tool. See nuttx/README.txt
+ and misc/tools/
+
+ b. Execute 'make menuconfig' in nuttx/ in order to start the
+ reconfiguration process.
- SD Card Support
- ---------------
- SD card support is built into this example by default:
+ 2. Serial Output
+
+ The OS test produces all of its test output on the serial console.
+ This configuration has UART1 enabled as a serial console.
+
+ 3. SD Card Support
+
+ SD card support is built into this example by default:
- CONFIG_PIC32MX_SPI1=y
- CONFIG_NSH_ARCHINIT=y
-
- The SD card can be mounted from the NSH command line as follows:
-
- nsh> mount -t vfat /dev/mmcsd0 /mnt/sdcard
- nsh> ls -l /mnt/sdcard
- /mnt/sdcard:
- -rw-rw-rw- 16 ATEST.TXT
- -rw-rw-rw- 21170 TODO
- -rw-rw-rw- 22 ANOTHER.TXT
- -rw-rw-rw- 22 HI2148.TXT
- -rw-rw-rw- 16 HiFromNotePad.txt
-
- USB Configurations.
- ------------------
- USB device support is enabled by default in this configuration.
- The following settings are defined by default (and can be set
- to 'n' to disabled USB device support).
+ CONFIG_PIC32MX_SPI1=y
+ CONFIG_NSH_ARCHINIT=y
+
+ The SD card can be mounted from the NSH command line as follows:
+
+ nsh> mount -t vfat /dev/mmcsd0 /mnt/sdcard
+ nsh> ls -l /mnt/sdcard
+ /mnt/sdcard:
+ -rw-rw-rw- 16 ATEST.TXT
+ -rw-rw-rw- 21170 TODO
+ -rw-rw-rw- 22 ANOTHER.TXT
+ -rw-rw-rw- 22 HI2148.TXT
+ -rw-rw-rw- 16 HiFromNotePad.txt
+
+ 4. USB Configurations
+
+ USB device support is enabled by default in this configuration.
+ The following settings are defined by default (and can be set
+ to 'n' to disabled USB device support).
- CONFIG_USBDEV=y : Enable basic USB device support
- CONFIG_PIC32MX_USBDEV=y : Enable PIC32 USB device support
- CONFIG_USBMSC=y : USB supports a mass storage device.
+ CONFIG_USBDEV=y : Enable basic USB device support
+ CONFIG_PIC32MX_USBDEV=y : Enable PIC32 USB device support
+ CONFIG_USBMSC=y : USB supports a mass storage device.
- In this configuration, NSH will support the following commands:
+ In this configuration, NSH will support the following commands:
- msconn : Connect the mass storage device, exportint the SD
- card as the USB mass storage logical unit.
- msdis : Disconnect the USB mass storage device
+ msconn : Connect the mass storage device, exportint the SD
+ card as the USB mass storage logical unit.
+ msdis : Disconnect the USB mass storage device
- NOTE: The SD card should *not* be mounted under NSH *and* exported
- by the mass storage device!!! That can result in corruption of the
- SD card format. This is the sequence of commands that you should
- use to work with the SD card safely:
-
- mount -t vfat /dev/mmcsd0 /mnt/sdcard : Mount the SD card initially
- ...
- umount /mnt/sdcard : Unmount the SD card before connecting
- msconn : Connect the USB MSC
- ...
- msdis : Disconnect the USB MSC
- mount -t vfat /dev/mmcsd0 /mnt/sdcard : Re-mount the SD card
- ...
+ NOTE: The SD card should *not* be mounted under NSH *and* exported
+ by the mass storage device!!! That can result in corruption of the
+ SD card format. This is the sequence of commands that you should
+ use to work with the SD card safely:
+
+ mount -t vfat /dev/mmcsd0 /mnt/sdcard : Mount the SD card initially
+ ...
+ umount /mnt/sdcard : Unmount the SD card before connecting
+ msconn : Connect the USB MSC
+ ...
+ msdis : Disconnect the USB MSC
+ mount -t vfat /dev/mmcsd0 /mnt/sdcard : Re-mount the SD card
+ ...
- Other USB other device configurations can be enabled and
- included as NSH built-in built in functions.
+ Other USB other device configurations can be enabled and
+ included as NSH built-in built in functions.
- examples/usbterm - This option can be enabled by uncommenting
- the following line in the appconfig file:
+ examples/usbterm - This option can be enabled by adding the
+ following to the NuttX configuration file:
- CONFIGURED_APPS += examples/usbterm
+ CONFIG_EXAMPLES_USBTERM=y
- And by enabling one of the USB serial devices:
+ And by enabling one of the USB serial devices:
- CONFIG_USBMSC=n : Disable USB mass storage device.
- CONFIG_PL2303=y : Enable the Prolifics PL2303 emulation
- CONFIG_CDCACM=y : or the CDC/ACM serial driver (not both)
+ CONFIG_USBMSC=n : Disable USB mass storage device.
+ CONFIG_PL2303=y : Enable the Prolifics PL2303 emulation
+ CONFIG_CDCACM=y : or the CDC/ACM serial driver (not both)
- system/cdcacm - The system/cdcacm program can be included as an
- function by uncommenting the following line in the appconfig file:
+ system/cdcacm - The system/cdcacm program can be included as an
+ function by adding the following to the NuttX configuration file:
- CONFIGURED_APPS += system/cdcacm
-
- and defining the following in your .config file:
+ CONFIG_SYSTEM_CDCACM=y
- CONFIG_USBMSC=n : Disable USB mass storage device.
- CONFIG_CDCACM=y : Enable the CDCACM device
+ and defining the following in your .config file:
- Networking Configurations.
- --------------------------
- Networking is enabled by default in this configuration:
+ CONFIG_USBMSC=n : Disable USB mass storage device.
+ CONFIG_CDCACM=y : Enable the CDCACM device
- CONFIG_NET=y : Enable networking support
- CONFIG_PIC32MX_ETHERNET=y : Enable the PIC32 Ethernet driver
- CONFIG_NSH_TELNET=y : Enable the Telnet NSH console (optional)
+ 5. Networking Configurations
- The default configuration has:
+ Networking is enabled by default in this configuration:
- CONFIG_NSH_DHCPC=n : DHCP is disabled
- CONFIG_NSH_IPADDR=(10<<24|0<<16|0<<8|2) : Target IP address 10.0.0.2
- CONFIG_NSH_DRIPADDR=(10<<24|0<<16|0<<8|1) : Host IP address 10.0.0.1
+ CONFIG_NET=y : Enable networking support
+ CONFIG_PIC32MX_ETHERNET=y : Enable the PIC32 Ethernet driver
+ CONFIG_NSH_TELNET=y : Enable the Telnet NSH console (optional)
- This will probably need to be customized for your network.
-
- NOTES:
- 1. This logic will assume that a network is connected. During its
- initialization, it will try to negotiate the link speed. If you have
- no network connected when you reset the board, there will be a long
- delay (maybe 30 seconds?) before anything happens. That is the timeout
- before the networking finally gives up and decides that no network is
- available.
+ The default configuration has:
- 2. This example can support an FTP client. In order to build in FTP client
- support simply uncomment the following lines in the appconfig file (before
- configuring) or in the apps/.config file (after configuring):
+ CONFIG_NSH_DHCPC=n : DHCP is disabled
+ CONFIG_NSH_IPADDR=(10<<24|0<<16|0<<8|2) : Target IP address 10.0.0.2
+ CONFIG_NSH_DRIPADDR=(10<<24|0<<16|0<<8|1) : Host IP address 10.0.0.1
- #CONFIGURED_APPS += netutils/ftpc
- #CONFIGURED_APPS += examples/ftpc
+ This will probably need to be customized for your network.
+
+ NOTES:
- 3. This example can support an FTP server. In order to build in FTP server
- support simply uncomment the following lines in the appconfig file (before
- configuring) or in the apps/.config file (after configuring):
+ a. This logic will assume that a network is connected. During its
+ initialization, it will try to negotiate the link speed. If you have
+ no network connected when you reset the board, there will be a long
+ delay (maybe 30 seconds?) before anything happens. That is the timeout
+ before the networking finally gives up and decides that no network is
+ available.
- #CONFIGURED_APPS += netutils/ftpd
- #CONFIGURED_APPS += examples/ftpd
+ b. This example can support an FTP client. In order to build in FTP client
+ support simply add the following to the NuttX configuration file:
- And enable poll() support in the NuttX configuration file:
+ CONFIG_NETUTILS_FTPC=y
+ CONFIG_EXAMPLES_FTPC=y
- CONFIG_DISABLE_POLL=n
+ 3. This example can support an FTP server. In order to build in FTP server
+ support simply add the following to the NuttX configuration file:
- Using a RAM disk and the USB MSC device to the nsh configuration
- ----------------------------------------------------------------
- Here is an experimental change to examples/nsh that will create a RAM
- disk and attempt to export that RAM disk as a USB mass storage device.
+ CONFIG_NETUTILS_FTPD=y
+ CONFIG_SYSTEM_FTPD=y
- 1. Changes to nuttx/.config
+ And enable poll() support in the NuttX configuration file:
- a) Enable support for the PIC32 USB device
+ CONFIG_DISABLE_POLL=n
- -CONFIG_PIC32MX_USBDEV=n
- +CONFIG_PIC32MX_USBDEV=y
+ 6. Using a RAM disk and the USB MSC device to the nsh configuration
- b) Enable NuttX USB device support
+ Here is an experimental change to examples/nsh that will create a RAM
+ disk and attempt to export that RAM disk as a USB mass storage device.
- -CONFIG_USBDEV=n
- +CONFIG_USBDEV=y
+ 1. Changes to nuttx/.config
- c) Enable the USB MSC class driver
+ a) Enable support for the PIC32 USB device
- -CONFIG_USBMSC=n
- +CONFIG_USBMSC=y
+ -CONFIG_PIC32MX_USBDEV=n
+ +CONFIG_PIC32MX_USBDEV=y
- d) Use a RAM disk (instead of an SD card) as the USB MSC logical unit:
+ b) Enable NuttX USB device support
- -CONFIG_SYSTEM_USBMSC_DEVPATH1="/dev/mmcsd0"
- +CONFIG_SYSTEM_USBMSC_DEVPATH1="/dev/ram0"
+ -CONFIG_USBDEV=n
+ +CONFIG_USBDEV=y
- 2. Changes to nuttx/.config.
+ c) Enable the USB MSC class driver
- a) Enable building of the system/usbmsc:
+ -CONFIG_USBMSC=n
+ +CONFIG_USBMSC=y
- -# CONFIGURED_APPS += system/usbmsc
- + CONFIGURED_APPS += system/usbmsc
+ d) Use a RAM disk (instead of an SD card) as the USB MSC logical unit:
- 3. When NSH first comes up, you must manually create the RAM disk
- before exporting it:
+ -CONFIG_SYSTEM_USBMSC_DEVPATH1="/dev/mmcsd0"
+ +CONFIG_SYSTEM_USBMSC_DEVPATH1="/dev/ram0"
- a) Create a 64Kb RAM disk at /dev/ram0:
+ 2. Changes to nuttx/.config.
- nsh> mkrd -s 512 128
+ a) Enable building of the system/usbmsc:
- b) Put a FAT file system on the RAM disk:
-
- nsh> mkfatfs /dev/ram0
+ CONFIG_SYSTEM_USBMSC=y
- b) Now the 'msconn' command will connect to the host and
- export /dev/ram0 as the USB logical unit:
+ 3. When NSH first comes up, you must manually create the RAM disk
+ before exporting it:
- nsh> msconn
+ a) Create a 64Kb RAM disk at /dev/ram0:
- NOTE: This modification should be considered experimental. IN the
- little testing I have done with it, it appears functional. But the
- logic has not been stressed and there could still be lurking issues.
- (There is a bug associated with this configuration listed in the
- top-level TODO list).
+ nsh> mkrd -s 512 128
- Adding LCD and graphics support to the nsh configuration:
- --------------------------------------------------------
+ b) Put a FAT file system on the RAM disk:
+
+ nsh> mkfatfs /dev/ram0
- LCD support is already enabled in defconfig (nuttx/.config):
+ b) Now the 'msconn' command will connect to the host and
+ export /dev/ram0 as the USB logical unit:
- CONFIG_NX=y : Enable graphics suppport
- CONFIG_PIC32MX_PMP=y : Enable parallel port support
- CONFIG_LCD_MIO283QT2=y : MIO283QT2 LCD support
+ nsh> msconn
- But you will have to enable a specific graphics example application
- in order to see anything.
-
- appconfig (apps/.config): Enable the application configurations that you
- want to use. Asexamples:
+ NOTE: This modification should be considered experimental. IN the
+ little testing I have done with it, it appears functional. But the
+ logic has not been stressed and there could still be lurking issues.
+ (There is a bug associated with this configuration listed in the
+ top-level TODO list).
- CONFIGURED_APPS += examples/nx : Pick one or more
- CONFIGURED_APPS += examples/nxhello :
- CONFIGURED_APPS += examples/nximage :
- CONFIGURED_APPS += examples/nxlines :
+ 7. Adding LCD and graphics support to the nsh configuration
- Enabling touch screen support in the nsh configuaration
- -------------------------------------------------------
+ LCD support is already enabled in defconfig (nuttx/.config):
- In defconfig (or nuttx/.config), set:
+ CONFIG_NX=y : Enable graphics suppport
+ CONFIG_PIC32MX_PMP=y : Enable parallel port support
+ CONFIG_LCD_MIO283QT2=y : MIO283QT2 LCD support
- CONFIG_INPUT=y : Enable input device support
- CONFIG_SCHED_WORKQUEUE=y : Work queue support needed
+ But you will have to enable a specific graphics example application
+ in the NuttX configuration file in order to see anything.
+
+ 8. Enabling touch screen support in the nsh configuaration
- In appconfig (or apps/.config), uncomment:
+ In defconfig (or nuttx/.config), set:
- CONFIGURED_APPS += examples/touchscreen
+ CONFIG_INPUT=y : Enable input device support
+ CONFIG_SCHED_WORKQUEUE=y : Work queue support needed
+ CONFIG_EXAMPLES_TOUCHSCREEN=y : Touchscreen example code