diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html index 55b6978ff0..7da6aafd40 100644 --- a/Documentation/NuttxPortingGuide.html +++ b/Documentation/NuttxPortingGuide.html @@ -4313,2441 +4313,21 @@ void (*notify)(FAR struct pm_callback_s *cb, enum pm_state_e pmstate);

- The following variables are recognized by the build (you may - also include architecture-specific settings). + At one time, this section provided a list of all NuttX configuration variables. + However, NuttX has since converted to use the kconfig-frontends tools. + Now, the NuttX configuration is determined by a self-documenting set of Kconfig files.

- Note. - This appendix is deprecated. - Documentation of NuttX configuration is now provided in a separate, auto-generated Configuration Variable Document. - That configuration variable document is generated using the kconfig2html tool - That tool analyzes the NuttX Kconfig files and generates the HTML document. - As a consequence, this file may not be present at any given time but can be regenerated following the instructions in tools directory README file. -

- -

Architecture selection

-

- The following configuration items select the architecture, chip, and - board configuration for the build. -

- - -

- Some architectures require a description of the RAM configuration: -

- - -

Build Options

-

- General build options: -

- -

- Building application code: -

- -

- Two-pass Build Options. - If the 2 pass build option is selected, then these options configure the make system build a extra link object. - This link object is assumed to be an incremental (relative) link object, but could be a static library (archive) - (some modification to this Makefile would be required if CONFIG_PASS1_TARGET generates an archive). - Pass 1 1ncremental (relative) link objects should be put into the processor-specific source directory - where other link objects will be created - ff the pass1 obect is an archive, it could go anywhere. -

- -

- When the two pass build option is enabled, the following also apply: -

- - -

Debug Options

-

- General Debug setup options are provided to (1) enable and control debug console output, (2) to build NuttX for use with a debugger, and (3) to enable specific debug features: -

- -

- If debug features are enabled with CONFIG_DEBUG (and possibly CONFIG_DEBUG_VERBOSE), then debug console output can also be enabled on a subsystem-by-subsystem basis. - Below are debug subsystems that are generally available on all platforms: -

-

- The following debug options may also be used with certain ports that support these features: -

- - -

Memory Management

- - -

General OS setup

- -

- Signal Numbers: -

- - -

- Binary Loaders: -

- - -

- System Logging: -

- - -

- Kernel build options: -

- - -

- OS setup related to on-demand paging: -

-
- -

- If CONFIG_PAGING is selected, then you will probabaly need CONFIG_BUILD_2PASS to correctly position - the code and the following configuration options also apply: -

- -

- Disabling OS Features. - The following can be used to disable categories of APIs supported - by the OS. If the compiler supports weak functions, then it - should not be necessary to disable functions unless you want to - restrict usage of those APIs. + The current NuttX configuration variables are also documented in separate, auto-generated configuration variable document. + That configuration variable document is generated using the kconfig2html tool that can be found in the nuttx/tools directory. + That tool analyzes the NuttX Kconfig files and generates excruciatingly boring HTML document.

- There are certain dependency relationships in these features. -

- - - - -

Miscellaneous libc settings

- - - -

Allow for architecture optimized implementations

- - - -

Sizes of configurable things (0 disables)

- - - -

File Systems

- - -

Device Drivers

-

RTC

- - -

CAN driver

- - -

SPI driver

- - -

SPI-based MMC/SD driver

- - -

SDIO/SDHC driver

- - -

SDIO-based MMC/SD driver

- - -

RiT P14201 OLED driver

- - -

Nokia 6100 Configuration Settings:

- - -

Input Devices

- - -

Analog Devices

- - -

ENC28J60 Ethernet Driver Configuration Settings

- - -

Network Support

-

TCP/IP and UDP support via uIP

- - -

SLIP

-

- The NuttX SLIP driver supports point-to-point IP communications over a serial port. - The default data link layer for uIP is Ethernet. - If CONFIG_NET_SLIP is defined in the NuttX configuration file, then SLIP will be supported. - The basic differences between the SLIP and Ethernet configurations is that when SLIP is selected: -

- If CONFIG_NET_SLIP is not selected, then Ethernet will be used - (there is no need to define anything special in the configuration file to use Ethernet -- it is the default). -

- - -

UIP Network Utilities

- - -

THTTPD

- - -

FTP Server

- -

- Other required FTPD configuration settings: Of course TCP networking support is required. But here are a couple that are less obvious: -

- - -

USB Device-Side Support

-

USB Device Controller Driver

- - -

USB Serial Device Class Driver (Prolific PL2303 Emulation)

- - -

USB serial device class driver (Standard CDC ACM class)

- - -

USB Storage Device Configuration

- - -

USB Composite Device Configuration

- - -

USB Host-Side Support

-

USB Host Controller Driver

- -

USB Host HID Class Driver

-

- Requires CONFIG_USBHOST=y, CONFIG_USBHOST_INT_DISABLE=n, CONFIG_NFILE_DESCRIPTORS > 0, - CONFIG_SCHED_WORKQUEUE=y, and CONFIG_DISABLE_SIGNALS=n. -

- -

USB Host HID Mass Storage Class Driver

-

- Requires CONFIG_USBHOST=y, CONFIG_USBHOST_BULK_DISABLE=n, CONFIG_NFILE_DESCRIPTORS > 0, - and CONFIG_SCHED_WORKQUEUE=y. -

- -

Graphics related configuration settings

-
  • - CONFIG_NX: - Enables overall support for graphics library and NX -
  • - - -

    NX configuration setting

    - - -

    NX Multi-user only options

    - - -

    Stack and heap information

    - -