diff options
| author | Gregory Nutt <gnutt@nuttx.org> | 2013-12-20 18:25:36 -0600 |
|---|---|---|
| committer | Gregory Nutt <gnutt@nuttx.org> | 2013-12-20 18:25:36 -0600 |
| commit | 9df42eebb0f4bba2b6c9e93038e07aa14feb4558 (patch) | |
| tree | d8bac5eecdae0f387394e5460616863eb93f6dde /nuttx | |
| parent | 914aaccf48daf6e8fcf7f39fb8739100c57746bf (diff) | |
| download | nuttx-9df42eebb0f4bba2b6c9e93038e07aa14feb4558.tar.gz nuttx-9df42eebb0f4bba2b6c9e93038e07aa14feb4558.tar.bz2 nuttx-9df42eebb0f4bba2b6c9e93038e07aa14feb4558.zip | |
Remove all configuration variable documentation from configs/README.txt and Docuemntation/NuttXPortingGuidle.html. The current NuttX configuration is documented in Kconfig files and in Documentation/NuttXSonfigVariables.html. The older configuration variable documentation is not being maintained and, hence, is a liability
Diffstat (limited to 'nuttx')
| -rw-r--r-- | nuttx/ChangeLog | 8 | ||||
| -rw-r--r-- | nuttx/Documentation/NuttxPortingGuide.html | 2438 | ||||
| -rw-r--r-- | nuttx/configs/README.txt | 1572 |
3 files changed, 39 insertions, 3979 deletions
diff --git a/nuttx/ChangeLog b/nuttx/ChangeLog index 641634c6c..b0f4e6b08 100644 --- a/nuttx/ChangeLog +++ b/nuttx/ChangeLog @@ -6243,3 +6243,11 @@ * Kconfig and all Make.defs files: Add CONFIG_DEBUG_NOOPT. Now you can indepenently enable/disable debug symbols and optimization (2013-12-20). + * configs/README.txt and Documentation/NuttxPortingGuide.html: + Remove documentation of NuttX configuration variables. Since + converting to the kconfig-frontend tools, the NuttX configuration + is now documented in the Kconfig files and summarized in the + autogenerated Documentation/NuttXConfigVariables.html file. + This old configuration variable documentation is now a liability + and, hence, was removed (2013-12-20). + diff --git a/nuttx/Documentation/NuttxPortingGuide.html b/nuttx/Documentation/NuttxPortingGuide.html index 55b6978ff..7da6aafd4 100644 --- a/nuttx/Documentation/NuttxPortingGuide.html +++ b/nuttx/Documentation/NuttxPortingGuide.html @@ -4313,2441 +4313,21 @@ void (*notify)(FAR struct pm_callback_s *cb, enum pm_state_e pmstate); </table> <p> - 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 <a href="http://ymorin.is-a-geek.org/projects/kconfig-frontends">kconfig-frontends</a> tools. + Now, the NuttX configuration is determined by a self-documenting set of <code>Kconfig</code> files. </p> <p> - <b>Note</b>. - This appendix is deprecated. - Documentation of NuttX configuration is now provided in a separate, auto-generated <a href="NuttXConfigVariables.html">Configuration Variable Document</a>. - That configuration variable document is generated using the <a href="http://sourceforge.net/p/nuttx/git/ci/master/tree/nuttx/tools/kconfig2html.c">kconfig2html</a> tool - That tool analyzes the NuttX <code>Kconfig</code> 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 <code>tools</code> directory <a href="http://sourceforge.net/p/nuttx/git/ci/master/tree/nuttx/tools/README.txt">README</a> file. + The current NuttX configuration variables are also documented in separate, auto-generated configuration variable document. + That configuration variable document is generated using the <code>kconfig2html</code> tool that can be found in the <code>nuttx/tools</code> directory. + That tool analyzes the NuttX Kconfig files and generates excruciatingly boring HTML document. </p> - -<h2>Architecture selection</h2> -<p> - The following configuration items select the architecture, chip, and - board configuration for the build. -</p> -<ul> - <li><code>CONFIG_ARCH</code>: - Identifies the arch subdirectory</li> - <li><code>CONFIG_ARCH_name</code>: - For use in C code</li> - <li><code>CONFIG_ARCH_CHIP</code>: - Identifies the arch/*/chip subdirectory</li> - <li><code>CONFIG_ARCH_CHIP_name</code>: - For use in C code</li> - <li><code>CONFIG_ARCH_BOARD</code>: - Identifies the configs subdirectory and hence, the board that supports - the particular chip or SoC.</li> - <li><code>CONFIG_ARCH_BOARD_name</code>: - For use in C code</li> - <li><code>CONFIG_ENDIAN_BIG</code>: - Define if big endian (default is little endian).</li> - <li><code>CONFIG_ARCH_NOINTC</code>: - Define if the architecture does not support an interrupt controller - or otherwise cannot support APIs like up_enable_irq() and up_disable_irq().</li> - <li><code>CONFIG_ARCH_VECNOTIRQ</code>: - Usually the interrupt vector number provided to interfaces like <code>irq_attach()</code> - and <code>irq_detach</code> are the same as IRQ numbers that are provied to IRQ - management functions like <code>up_enable_irq()</code> and <code>up_disable_irq()</code>. - But that is not true for all interrupt controller implementations. For example, the - PIC32MX interrupt controller manages interrupt sources that have a many-to-one - relationship to interrupt vectors. - In such cases, <code>CONFIG_ARCH_VECNOTIRQ</code> must defined so that the OS logic - will know not to assume it can use a vector number to enable or disable interrupts. - <li><code>CONFIG_ARCH_IRQPRIO</code>: - Define if the architecture supports prioritization of interrupts and the - up_prioritize_irq() API.</li> - <li><code>CONFIG_ADDRENV</code>: - The CPU supports an MMU and CPU port supports provision of address - environments for tasks (making the, perhaps, processes). - In this case, the CPU-specific logic must provide a set of address environment interfaces as defined in the <a href="#addrenv">Address Environments</a> paragraph. - </li> -</ul> - -<p> - Some architectures require a description of the RAM configuration: -</p> -<ul> - <li><code>CONFIG_RAM_SIZE</code>: - Describes the primary installed RAM.</li> - <li><code>CONFIG_RAM_START</code>: - The start address of primary RAM (physical)</li> - <li><code>CONFIG_RAM_VSTART</code>: - The start address of primary RAM (virtual). This is only needed on platforms that support address mapping.</li> -</ul> - -<h2>Build Options</h2> -<p> - General build options: -</p> -<ul> - <li><code>CONFIG_RRLOAD_BINARY</code>: - Make the rrload binary format used with BSPs from <a href="www.ridgerun.com">ridgerun.com</a> - using the <code>tools/mkimage.sh</code> script. - </li> - <li><code>CONFIG_INTELHEX_BINARY</code>: - Make the Intel HEX binary format used with many different loaders using the GNU objcopy program - This option should not be selected if you are not using the GNU toolchain. - </li> - <li><code>CONFIG_MOTOROLA_SREC</code>: - Make the Motorola S-Record binary format used with many different loaders using the GNU objcopy program - Should not be selected if you are not using the GNU toolchain. - </li> - <li><code>CONFIG_RAW_BINARY</code>: - Make a raw binary format file used with many different loaders using the GNU objcopy program. - This option should not be selected if you are not using the GNU toolchain. - </li> - <li><code>CONFIG_HAVE_CXX</code>: - Toolchain supports C++ and <code>CXX</code>, <code>CXXFLAGS</code>, and <code>COMPILEXX</code> - have been defined in the configurations <code>Make.defs</code> file. - </li> - <li><code>CONFIG_HAVE_CXXINITIALIZE</code>: - The platform-specific logic includes support for initialization of static C++ instances for this architecture and for the selected toolchain (via <code>up_cxxinitialize()</code>). - </li> -</ul> -<p> - Building application code: -</p> -<ul> - <li> - <p> - <code>CONFIG_APPS_DIR</code>: Identifies the directory that builds the application to link with NuttX. - This symbol must be assigned to the path of the application build directory <i>relative</i> to the NuttX top build directory. - If the application resides in the top-level <code>../apps/</code> directory, it is not necessary to define <code>CONFIG_APPS_DIR</code>. - If you have an application directory and the NuttX directory each in separate directories such as this: -<ul><pre> -build - |-nuttx - | | - | `- Makefile - `-application - | - `- Makefile -</pre></ul> - Then you would set <code>CONFIG_APPS_DIR=../application</code>. - The default value of <code>CONFIG_APPS_DIR</code> is <code>../apps/</code>. - </p> - <p> - The application direction must contain <code>Makefile</code> and this make file must support the following targets: - <ul> - <li> - <code>libapps$(LIBEXT)</code> (usually <code>libapps.a</code>). - <code>libapps.a</code> is a static library ( an archive) that contains all of application object files. - </li> - <li> - <code>clean</code>. - Do whatever is appropriate to clean the application directories for a fresh build. - </li> - <li> - <code>distclean</code>. - Clean everthing -- auto-generated files, symbolic links etc. -- so that the directory contents are the same as the contents in your configuration management system. - This is only done when you change the NuttX configuration. - </li> - <li> - <code>context</code>. - Perform one-time configuration-related setup. - This might includes such things as creating auto-generated files or symbolic links for directory configurations. - </li> - <li> - <code>depend</code>. - Make or update the application build dependencies. - </li> - </ul> - </p> - <p> - When this application is invoked it will receive the setting <code>TOPDIR</code> like: - <ul> - <code>$(MAKE) -C $(CONFIG_APPS_DIR) TOPDIR="$(TOPDIR)"</code> <target> - </ul> - </p> - <p> - <code>TOPDIR</code> is the full path to the NuttX directory. - It can be used, for example, to include makefile fragments (e.g., <code>.config</code> or <code>Make.defs</code>) or to set up include file paths. - </p> - </li> -</ul> -<p> - 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. -</p> -<ul> - <li> - <code>CONFIG_BUILD_2PASS</code>: - Enables the two pass build options. - </li> -</ul> -<p> - When the two pass build option is enabled, the following also apply: -</p> -<ul> - <li> - <p> - <code>CONFIG_PASS1_TARGET</code>: The name of the first pass build target. - </p> - </li> - <li><code>CONFIG_PASS1_BUILDIR</code>: - <p> - The path, relative to the top NuttX build directory to directory that contains the Makefile to build the first pass object. - The Makefile must support the following targets: - </p> - <p> - <ul> - <li>The special target <code>CONFIG_PASS1_TARGET</code> (if defined), and</li> - <li>The usual depend, clean, and distclean targets.</li> - </ul> - </p> - </li> - <li> - <code>CONFIG_PASS1_OBJECT</code>: May be used to include an extra, pass1 object into the final link. - This would probably be the object generated from the <code>CONFIG_PASS1_TARGET</code>. - It may be available at link time in the <code>arch/<architecture>/src</code> directory. - </li> -</ul> - -<h2>Debug Options</h2> -<p> - 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: - </p> -<ul> - <li> - <code>CONFIG_DEBUG</code>: enables built-in debug options. - This includes more extensive parameter checking, debug assertions, and other debug logic. - This option is also necessary (but not sufficient) to enable debug syslog output; - Debug syslog output must also be enabled on a subsystem-by-subsystem basis as described below. - </li> - <li> - <code>CONFIG_DEBUG_VERBOSE</code>: If debug syslog output is enabled, the option enables more verbose debug output. - Ignored if <code>CONFIG_DEBUG</code> is not defined. - If only <code>CONFIG_DEBUG</code> then the only output will be errors, warnings, and critical information. - If <code>CONFIG_DEBUG_VERBOSE</code> is defined in addition, then general debug comments will also be included in the syslog output. - </li> - <li> - <code>CONFIG_SYSLOG_ENABLE</code>: Support an interface to enable or disable syslog output. - </li> - <li> - <code>CONFIG_DEBUG_SYMBOLS</code>: build without optimization and with debug symbols (needed for use with a debugger). - This option has nothing to do with debug output. - </li> - <li> - <code>CONFIG_DEBUG_STACK</code>: a few ports include logic to monitor stack usage. - If the NuttX port supports this option, it would be enabled with this option. - This option also requires <code>CONFIG_DEBUG</code> to enable general debug features. - </li> -</ul> -<p> - If debug features are enabled with <code>CONFIG_DEBUG</code> (and possibly <code>CONFIG_DEBUG_VERBOSE</code>), 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: -<ul> - <li> - <code>CONFIG_DEBUG_SCHED</code>: enable OS debug output (disabled by default) - </li> - <li> - <code>CONFIG_DEBUG_MM</code>: enable memory management debug output (disabled by default) - </li> - <li> - <code>CONFIG_DEBUG_NET</code>: enable network debug output (disabled by default) - </li> - <li> - <code>CONFIG_DEBUG_USB</code>: enable USB debug output (disabled by default) - </li> - <li> - <code>CONFIG_DEBUG_FS</code>: enable file system debug output (disabled by default) - </li> - <li> - <code>CONFIG_DEBUG_LIB</code>: enable C library debug output (disabled by default) - </li> - <li> - <code>CONFIG_DEBUG_BINFMT</code>: enable binary loader debug output (disabled by default) - </li> - <li> - <code>CONFIG_DEBUG_GRAPHICS</code>: enable NX graphics debug output (disabled by default) - </li> -</ul> -<p> - The following debug options may also be used with certain ports that support these features: -</p> -<ul> - <li> - <code>CONFIG_DEBUG_DMA</code>: enable DMA controller debug output (disabled by default) - </li> - <li> - <code>CONFIG_DEBUG_GPIO</code>: enable detail GPIO usage debug output (disabled by default) - </li> - <li> - <code>CONFIG_DEBUG_PAGING</code>: enable on-demand paging debug output (disabled by default) - </li> -</ul> - -<h2>Memory Management</h2> -<ul> - <li> - <code>CONFIG_MM_REGIONS</code>: If the architecture includes multiple - regions of memory to allocate from, this specifies the - number of memory regions that the memory manager must - handle and enables the API <code>mm_addregion(heap, start, end)</code>. - </li> - <li> - <code>CONFIG_MM_SMALL</code>: Each memory allocation has a small allocation - overhead. The size of that overhead is normally determined by - the "width" of the address support by the MCU. MCUs that support - 16-bit addressability have smaller overhead than devices that - support 32-bit addressability. However, there are many MCUs - that support 32-bit addressability <i>but</i> have internal SRAM - of size less than or equal to 64K. In this case, CONFIG_MM_SMALL - can be defined so that those MCUs will also benefit from the - smaller, 16-bit-based allocation overhead. - </li> - <li> - <code>CONFIG_HEAP2_BASE</code> and <code>CONFIG_HEAP2_SIZE</code>: - Some architectures use these settings to specify the size of - a second heap region. - </li> - <li> - <code>CONFIG_GRAN</code>: - Enable granual allocator support. Allocations will be aligned to the - granule size; allocations will be in units of the granule size. - Larger granules will give better performance and less overhead but - more losses of memory due to alignment and quantization waste. - NOTE: The current implementation also restricts the maximum - allocation size to 32 granaules. That restriction could be - eliminated with some additional coding effort. - </li> - <li> - <code>CONFIG_GRAN_SINGLE</code>: - Select if there is only one instance of the granule allocator (i.e., - gran_initialize will be called only once. In this case, (1) there - are a few optimizations that can can be done and (2) the GRAN_HANDLE - is not needed. - </li> - <li> - <code>CONFIG_GRAN_INTR</code>: - Normally mutual exclusive access to granule allocator data is assured using a semaphore. - If this option is set then, instead, mutual exclusion logic will disable interrupts. - While this options is more invasive to system performance, it will also support use of the - granule allocator from interrupt level logic. - </li> - <li> - <code>CONFIG_DEBUG_GRAM</code>: - Just like <code>CONFIG_DEBUG_MM</code>, but only generates ouput from the gran - allocation logic. - </li> -</ul> - -<h2>General OS setup</h2> -<ul> - <li> - <code>CONFIG_ARCH_LOWPUTC</code>: architecture supports low-level, boot - time console output - </li> - <li> - <code>CONFIG_NUTTX_KERNEL</code>: - With most MCUs, NuttX is built as a flat, single executable image - containing the NuttX RTOS along with all application code. - The RTOS code and the application run in the same address space and at the same kernel-mode privileges. - If this option is selected, NuttX will be built separately as a monolithic, kernel-mode module and the applications - can be added as a separately built, user-mode module. - In this a system call layer will be built to support the user- to kernel-mode interface to the RTOS. - </li> - <li> - <code>CONFIG_MSEC_PER_TICK</code>: The default system timer is 100Hz - or <code>MSEC_PER_TICK</code>=10. This setting may be defined to inform NuttX - that the processor hardware is providing system timer interrupts at some interrupt - interval other than 10 msec. - </li> - <li> - <code>CONFIG_RR_INTERVAL</code>: The round robin time slice will be set - this number of milliseconds; Round robin scheduling can - be disabled by setting this value to zero. - </li> - <li> - <code>CONFIG_SCHED_INSTRUMENTATION</code>: enables instrumentation in - scheduler to monitor system performance - </li> - <li> - <code>CONFIG_TASK_NAME_SIZE</code>: Specifies that maximum size of a - task name to save in the TCB. Useful if scheduler - instrumentation is selected. Set to zero to disable. - </li> - <li> - <code>CONFIG_SCHED_HAVE_PARENT</code>: Remember the ID of the parent thread when a new child task is created. - This support enables some additional features (such as <code>SIGCHLD</code>) and modifies the behavior of other interfaces. - For example, it makes <code>waitpid()</code> more standards complete by restricting the waited-for tasks to the children of the caller. - Default: disabled. - </li> - <li> - <code>CONFIG_SCHED_CHILD_STATUS</code>: If this option is selected, then the exit status of the child task will be retained after the child task exits. - This option should be selected if you require knowledge of a child process' exit status. - Without this setting, <code>wait()</code>, <code>waitpid()</code> or <code>waitid()</code> may fail. - For example, if you do: - <p><ol> - <li> - Start child task - </li> - <li> - Wait for exit status (using <code>wait()</code>, <code>waitpid()</code> or <code>waitid()</code>). - </li> - </ol></p> - <p> - This can fail because the child task may run to completion before the wait begins. - There is a non-standard work-around in this case: - The above sequence will work if you disable pre-emption using <code>sched_lock()</code> prior to starting the child task, then re-enable pre-emption with <code>sched_unlock()</code> after the wait completes. - This works because the child task is not permitted to run until the wait is in place. - </p> - <p> - The standard solution would be to enable <code>CONFIG_SCHED_CHILD_STATUS</code>. - In this case the exit status of the child task is retained after the child exits and the wait will successful obtain the child task's exit status whether it is called before the child task exits or not. - </p> - <p> - <b>Warning</b>: - If you enable this feature, then your application must either (1) take responsibility for reaping the child status with <code>wait()</code>, <code>waitpid()</code> or <code>waitid()</code>, or (2) suppress retention of child status. - If you do not reap the child status, then you have a memory leak and your system will eventually fail. - </p> - Retention of child status can be suppressed on the parent using logic like: - </p> - <ul><pre> -struct sigaction sa; - -sa.sa_handler = SIG_IGN; -sa.sa_flags = SA_NOCLDWAIT; -int ret = sigaction(SIGCHLD, &sa, NULL); -</pre></ul> - </li> - <li> - <code>CONFIG_PREALLOC_CHILDSTATUS</code>: To prevent runaway child status allocations and to improve - allocation performance, child task exit status structures are pre-allocated when the system boots. - This setting determines the number of child status structures that will be pre-allocated. - If this setting is not defined or if it is defined to be zero then a value of 2*<code>MAX_TASKS</code> is used. - <p> - Note that there cannot be more that <code>CONFIG_MAX_TASKS</code> tasks in total. - However, the number of child status structures may need to be significantly larger because this number includes the maximum number of tasks that are running PLUS the number of tasks that have exit'ed without having their exit status reaped (via <code>wait()</code>, <code>waitpid()</code> or <code>waitid()</code>). - </p> - <p> - Obviously, if tasks spawn children indefinitely and never have the exit status reaped, then you may have a memory leak! - If you enable the <code>SCHED_CHILD_STATUS</code> feature, then your application must take responsibility for either (1) reaping the child status with <code>wait()</code>, <code>waitpid()</code> or <code>waitid()</code> or it must (2) suppress retention of child status. Otherwise, your system will eventually fail. - </p> - <p> - Retention of child status can be suppressed on the parent using logic like: - </p> - <ul><pre> -struct sigaction sa; - -sa.sa_handler = SIG_IGN; -sa.sa_flags = SA_NOCLDWAIT; -int ret = sigaction(SIGCHLD, &sa, NULL); -</pre></ul> - </li> - <li> - <code>CONFIG_SYSTEM_TIME16</code>: - The range of system time is, by default, 32-bits. - However, if the MCU supports type <code>long long</code> and <code>CONFIG_SYSTEM_TIME16</code> is selected, - a 64-bit system timer will be supported instead. - </li> - <li> - <code>CONFIG_START_YEAR</code>, <code>CONFIG_START_MONTH</code>, <code>CONFIG_START_DAY</code> - - Used to initialize the internal time logic. - </li> - <li> - <code>CONFIG_GREGORIAN_TIME</code>: Enables Gregorian time conversions. - You would only need this if you are concerned about accurate time conversions in - the recent past or in the distant future. - </li> - <li> - <code>CONFIG_JULIAN_TIME</code>: Enables Julian time conversions. - You would only need this if you are concerned about accurate time conversion in the distand past. - You must also define <code>CONFIG_GREGORIAN_TIME</code> in order to use Julian time. - </li> - <li> - <code>CONFIG_DEV_CONSOLE</code>: Set if architecture-specific logic provides <code>/dev/console</code>. - Enables <code>stdout</code>, <code>stderr</code>, and <code>stdin</code>. - This implies the "normal" serial driver provides the console unless another console device is specified - (See <code>CONFIG_DEV_LOWCONSOLE</code>). - </li> - <li> - <code>CONFIG_MUTEX_TYPES</code>: Set to enable support for recursive and - errorcheck mutexes. Enables <code>pthread_mutexattr_settype()</code>. - </li> - <li> - <code>CONFIG_PRIORITY_INHERITANCE</code>: Set to enable support for - priority inheritance on mutexes and semaphores. - Priority inheritance is a strategy of addressing - <a href="NuttxUserGuide.html#priorityinversion"><i>priority inversion</i></a>. - Details of the NuttX implementation of priority inheritance is - discussed <a href="NuttxUserGuide.html#priorityinheritance">elsewhere</a>. - </li> - <li> - <code>CONFIG_SEM_PREALLOCHOLDERS</code>: This setting is only used - if priority inheritance is enabled. - It defines the maximum number of different threads (minus one) that - can take counts on a semaphore with priority inheritance support. - This may be set to zero if priority inheritance is disabled OR if you - are only using semaphores as mutexes (only one holder) OR if no more - than two threads participate using a counting semaphore. - If defined, then this should be a relatively large number because this - is the total number of counts on the total number of semaphores (like - 64 or 100). - </li> - <li> - <code>CONFIG_SEM_NNESTPRIO</code>: If priority inheritance is enabled, - then this setting is the maximum number of higher priority threads (minus - 1) than can be waiting for another thread to release a count on a semaphore. - This value may be set to zero if no more than one thread is expected to - wait for a semaphore. - If defined, then this should be a relatively small number because this the - number of maximumum of waiters on one semaphore (like 4 or 8). - </li> - <li> - <code>CONFIG_FDCLONE_DISABLE</code>: Disable cloning of all file descriptors - by task_create() when a new task is started. - If set, all files/drivers will appear to be closed in the new task. - </li> - <li> - <code>CONFIG_FDCLONE_STDIO</code>: Disable cloning of all but the first - three file descriptors (stdin, stdout, stderr) by task_create() - when a new task is started. - If set, all files/drivers will appear to be closed in the new task except - for stdin, stdout, and stderr. - </li> - <li> - <code>CONFIG_SDCLONE_DISABLE</code>: Disable cloning of all socket - desciptors by task_create() when a new task is started. - If set, all sockets will appear to be closed in the new task. - </li> - <li> - <code>CONFIG_SCHED_WORKQUEUE</code>: Create a dedicated "worker" thread to - handle delayed processing from interrupt handlers. This feature - is required for some drivers but, if there are not complaints, - can be safely disabled. The worker thread also performs - garbage collection -- completing any delayed memory deallocations - from interrupt handlers. If the worker thread is disabled, - then that clean will be performed by the IDLE thread instead - (which runs at the lowest of priority and may not be appropriate - if memory reclamation is of high priority). If CONFIG_SCHED_WORKQUEUE - is enabled, then the following options can also be used: - </li> - <li> - <code>CONFIG_SCHED_WORKPRIORITY</code>: The execution priority of the worker - thread. Default: 50 - </li> - <li> - <code>CONFIG_SCHED_WORKPERIOD</code>: How often the worker thread checks for - work in units of microseconds. Default: 50*1000 (50 MS). - </li> - <li> - <code>CONFIG_SCHED_WORKSTACKSIZE</code>: The stack size allocated for the worker - thread. Default: CONFIG_IDLETHREAD_STACKSIZE. - </li> - <li> - <code>CONFIG_SIG_SIGWORK</code>: The signal number that will be used to wake-up - the worker thread. Default: 17 - </li> - <li> - <code>CONFIG_SCHED_LPWORK</code>: If CONFIG_SCHED_WORKQUEUE</code> is defined, then a single work queue is created by default. - If <code>CONFIG_SCHED_LPWORK</code> is also defined then an additional, lower-priority work queue will also be created. - This lower priority work queue is better suited for more extended processing (such as file system clean-up operations) - </li> - <li> - <code>CONFIG_SCHED_LPWORKPRIORITY</code>: The execution priority of the lower priority worker thread. Default: 50 - </li> - <li> - <code>CONFIG_SCHED_LPWORKPERIOD</code>: How often the lower priority worker thread checks for work in units of microseconds. Default: 50*1000 (50 MS). - </li> - <li> - <code>CONFIG_SCHED_LPWORKSTACKSIZE</code>: The stack size allocated for the lower priority worker thread. Default: CONFIG_IDLETHREAD_STACKSIZE. - </li> - <li> - <code>CONFIG_SCHED_WAITPID</code>: Enables the <a href="NuttxUserGuide.html#waitpid"><code>waitpid()</code><a> interface in a default, non-standard mode (non-standard in the sense that the waited for PID need not be child of the caller). - If <code>SCHED_HAVE_PARENT</code> is also defined, then this setting will modify the behavior or <a href="NuttxUserGuide.html#waitpid"><code>waitpid()</code><a> (making more spec compliant) and will enable the <a href="NuttxUserGuide.html#waitid"><code>waitid()</code><a> and <a href="NuttxUserGuide.html#wait"><code>waitp()</code><a> interfaces as well. - </li> - <li> - <code>CONFIG_SCHED_ATEXIT</code>: Enables the <a href="NuttxUserGuide.html#atexit">atexit()</code><a> API - </li> - <li> - <code>CONFIG_SCHED_ATEXIT_MAX</code>: By default if <code>CONFIG_SCHED_ATEXIT</code> is selected, only a single <code>atexit()</code> function is supported. - That number can be increased by defined this setting to the number that you require. - </li> - <li> - <code>CONFIG_SCHED_ONEXIT</code>: Enables the <a href="NuttxUserGuide.html#onexit">on_exit()</code><a> API - </li> - <li> - <code>CONFIG_SCHED_ONEXIT_MAX</code>: By default if <code>CONFIG_SCHED_ONEXIT</code> is selected, only a single <code>on_exit()</code> function is supported. - That number can be increased by defined this setting to the number that you require. - </li> - <li> - <code>CONFIG_USER_ENTRYPOINT</code>: The name of the entry point for user - applications. - For the example applications this is of the form <code>app_main</code> - where <code>app</code> is the application name. - If not defined, <code>CONFIG_USER_ENTRYPOINT</code> defaults to - <code>user_start</code>. - </li> -</ul> -<p> - <b>Signal Numbers</b>: -</p> -<ul> - <li> - <code>CONFIG_SIG_SIGUSR1</code>: - Value of standard user signal 1 (<code>SIGUSR1</code>). Default: 1 - </li> - <li> - <code>CONFIG_SIG_SIGUSR2</code>: - Value of standard user signal 2 (<code>SIGUSR2</code>). Default: 2 - </li> - <li> - <code>CONFIG_SIG_SIGALARM</code>: - Default the standard signal used with POSIX timers (<code>SIGALRM</code>). Default: 3 - </li> - <li> - <code>CONFIG_SIG_SIGCHLD</code>: - The <code>SIGCHLD</code> signal is sent to the parent of a child process when it exits, is interrupted (stopped), or resumes after being interrupted. - Default: 4 - </li> - <li> - <code>CONFIG_SIG_SIGCONDTIMEDOUT</code>: - This non-standard signal number is used in the implementation of <code>pthread_cond_timedwait()</code>. - Default 16. - </li> - <li> - <code>CONFIG_SIG_SIGWORK</code>: - <code>SIGWORK</code> is a non-standard signal used to wake up the internal NuttX worker thread. - Default: 17. - </li> -</ul> - -<p> - <b>Binary Loaders</b>: -</p> -<ul> - <li> - <code>CONFIG_BINFMT_DISABLE</code>: By default, support for loadable binary formats is built. - This logic may be suppressed be defining this setting. - </li> - <li> - <code>CONFIG_BINFMT_EXEPATH</code>: Use the contents of the <code>PATH</code> environment variable to locate executable files. Default: n - </li> - <li> - <code>CONFIG_PATH_INITIAL</code>: The initial value of the <code>PATH</code> variable. This is the colon-separated list of absolute paths. E.g., <code>"/bin:/usr/bin:/sbin"</code> - </li> - <li> - <code>CONFIG_BINFMT_CONSTRUCTORS</code>: Build in support for C++ constructors in loaded modules. - </li> - <li> - <code>CONFIG_SYMTAB_ORDEREDBYNAME</code>: Symbol tables are order by name (rather than value). - </li> - <li> - <code>CONFIG_NXFLAT</code>: Enable support for the NXFLAT binary format. - This format will support execution of NuttX binaries located - in a ROMFS file system (see <code>apps/examples/nxflat</code>). - </li> - <li> - <code>CONFIG_ELF</code>: Enable support for the ELF binary format. - This format will support execution of ELF binaries copied from a file system and relocated into RAM (see <code>apps/examples/elf</code>). - </li> - <p> - If <code>CONFIG_ELF</code> is selected, then these additional options are available: - </p> - <li> - <code>CONFIG_ELF_ALIGN_LOG2</code>: Align all sections to this Log2 value: 0->1, 1->2, 2->4, etc. - </li> - <li> - <code>CONFIG_ELF_STACKSIZE</code>: This is the default stack size that will will be used when starting ELF binaries. - </li> - <li> - <code>CONFIG_ELF_BUFFERSIZE</code>: This is an I/O buffer that is used to access the ELF file. Variable length items will need to be read (such as symbol names). - This is really just this initial size of the buffer; it will be reallocated as necessary to hold large symbol names). - Default: 128 - </li> - <li> - <code>CONFIG_ELF_BUFFERINCR</code>: This is an I/O buffer that is used to access the ELF file. Variable length items will need to be read (such as symbol names). - This value specifies the size increment to use each time the buffer is reallocated. - Default: 32 - </li> - <li> - <code>CONFIG_ELF_DUMPBUFFER</code>: Dump various ELF buffers for debug purposes. - This option requires <code>CONFIG_DEBUG</code> and <code>CONFIG_DEBUG_VERBOSE</code>. - </li> -</ul> - -<p> - <b>System Logging</b>: -</p> -<ul> - <li> - <code>CONFIG_SYSLOG</code>: Enables general system logging support. - </li> - <code>CONFIG_SYSLOG_DEVPATH</code>: The full path to the system logging device. - Default <code>"/dev/ramlog"</code> (RAMLOG) or <code>"dev/ttyS1;</code> (CHARDEV). - <p> - At present, there are two system loggins devices available. - If <code>CONFIG_SYSLOG</code> is selected, then these options are also available. - </p> - <p> - First, any a generic character device that may be used as the SYSLOG. - </p> - <li> - <code>CONFIG_SYSLOG_CHAR</code>: - Enable the generic character device for the SYSLOG. - A disadvantage of using the generic character device for the SYSLOG is that it cannot handle debug output generated from interrupt level handlers. - NOTE: No more than one SYSLOG device should be configured. - <p> - Alternatively, a circular buffer in RAM can be used as the SYSLOGing device. - The contents of this RAM buffer can be dumped using the NSH dmesg command. - </p> - <li> - <code>CONFIG_RAMLOG</code>: Enables the RAM logging feature - </li> - <li> - <code>CONFIG_RAMLOG_CONSOLE</code>: Use the RAM logging device as a system console. - If this feature is enabled (along with <code>CONFIG_DEV_CONSOLE</code>), then all - console output will be re-directed to a circular buffer in RAM. This - is useful, for example, if the only console is a Telnet console. Then - in that case, console output from non-Telnet threads will go to the - circular buffer and can be viewed using the NSH 'dmesg' command. - </li> - <li> - <code>CONFIG_RAMLOG_SYSLOG</code>: - Use the RAM logging device for the syslogging interface. - If this feature is enabled (along with <code>CONFIG_SYSLOG</code>), then all debug output (only) will be re-directed to the circular buffer in RAM. - This RAM log can be view from NSH using the <code>dmesg</code> command. - NOTE: Unlike the limited, generic character driver SYSLOG device, the RAMLOG <i>can</i> be used to generate debug output from interrupt level handlers. - </li> - <li> - <code>CONFIG_RAMLOG_NPOLLWAITERS</code>: The number of threads than can be waiting - for this driver on poll(). Default: 4 - </li> - <p> - If <code>CONFIG_RAMLOG_CONSOLE</code> or <code>CONFIG_RAMLOG_SYSLOG</code> is selected, then the - following may also be provided: - </p> - </li> - <li> - <code>CONFIG_RAMLOG_CONSOLE_BUFSIZE</code>: Size of the console RAM log. Default: 1024 - </li> -</ul> - -<p> - <b>Kernel build options</b>: -</p> -<ul> - <li> - <code>CONFIG_NUTTX_KERNEL</code>: Builds NuttX as a separately compiled kernel. - </li> - <code>CONFIG_SYS_RESERVED</code>: Reserved system call values for use by architecture-specific logic. - </li> -</ul> - -<p> - <b>OS setup related to on-demand paging</b>: -</p> -<ul> - <li> - <code>CONFIG_PAGING</code>: If set =y in your configation file, this setting will - enable the on-demand paging feature as described in - <a href="http://www.nuttx.org/Documentation/NuttXDemandPaging.html">NuttXDemandPaging.html</a>. - </li> -</ul> - -<p> - If CONFIG_PAGING is selected, then you will probabaly need <code>CONFIG_BUILD_2PASS</code> to correctly position - the code and the following configuration options also apply: -</p> -<ul> - <li> - <code>CONFIG_PAGING_PAGESIZE</code>: - The size of one managed page. - This must be a value supported by the processor's memory management unit. - </li> - <li> - <code>CONFIG_PAGING_NLOCKED</code>: - This is the number of locked pages in the memory map. - The locked address region will then be from <code>CONFIG_RAM_VSTART</code> through - (<code>CONFIG_RAM_VSTART</code> + <code>CONFIG_PAGING_PAGESIZE</code>*<code>CONFIG_PAGING_NLOCKED</code>) - </li> - <li> - <code>CONFIG_PAGING_LOCKED_PBASE</code> and <code>CONFIG_PAGING_LOCKED_VBASE</code>: - These may be defined to determine the base address of the locked page regions. - If neither are defined, the logic will be set the bases to <code>CONFIG_RAM_START</code> - and <code>CONFIG_RAM_VSTART</code> (i.e., it assumes that the base address of the locked - region is at the beginning of RAM). - <b>NOTE</b>: - In some architectures, it may be necessary to take some memory from the beginning - of this region for vectors or for a page table. - In such cases, <code>CONFIG_PAGING_LOCKED_P/VBASE</code> should take that into consideration - to prevent overlapping the locked memory region and the system data at the beginning of SRAM. - </li> - <li> - <code>CONFIG_PAGING_NPPAGED</code>: - This is the number of physical pages available to support the paged text region. - This paged region begins at - (<code>CONFIG_PAGING_LOCKED_PBASE</code> + <code>CONFIG_PAGING_PAGESIZE</code>*<code>CONFIG_PAGING_NPPAGED</code>) - and continues until - (<code>CONFIG_PAGING_LOCKED_PBASE</code> + <code>CONFIG_PAGING_PAGESIZE</code>*(<code>CONFIG_PAGING_NLOCKED</code> + - <code>CONFIG_PAGING_NPPAGED</code>) - </li> - <li> - <code>CONFIG_PAGING_NVPAGED</code>: - This actual size of the paged text region (in pages). - This is also the number of virtual pages required to support the entire paged region. - The on-demand paging feature is intended to support only the case where the virtual paged text - area is much larger the available physical pages. - Otherwise, why would you enable on-demand paging? - </li> - <li> - <code>CONFIG_PAGING_NDATA</code>: - This is the number of data pages in the memory map. - The data region will extend to the end of RAM unless overridden by a setting in the configuration file. - <b>NOTE</b>: - In some architectures, it may be necessary to take some memory from the end of RAM for page tables - or other system usage. - The configuration settings and linker directives must be cognizant of that: - <code>CONFIG_PAGING_NDATA</code> should be defined to prevent the data region from extending all the way to the end of memory. - </li> - <li> - <code>CONFIG_PAGING_DEFPRIO</code>: - The default, minimum priority of the page fill worker thread. - The priority of the page fill work thread will be boosted boosted dynmically so that it matches the - priority of the task on behalf of which it peforms the fill. - This defines the minimum priority that will be used. Default: 50. - </li> - <li> - <code>CONFIG_PAGING_STACKSIZE</code>: - Defines the size of the allocated stack for the page fill worker thread. Default: 1024. - </li> - <li> - <code>CONFIG_PAGING_BLOCKINGFILL</code>: - The architecture specific <code>up_fillpage()</code> function may be blocking or non-blocking. - If defined, this setting indicates that the <code>up_fillpage()</code> implementation will block until the - transfer is completed. Default: Undefined (non-blocking). - </li> - <li> - <code>CONFIG_PAGING_WORKPERIOD</code>: - The page fill worker thread will wake periodically even if there is no mapping to do. - This selection controls that wake-up period (in microseconds). - This wake-up a failsafe that will handle any cases where a single is lost (that would - really be a bug and shouldn't happen!) - and also supports timeouts for case of non-blocking, asynchronous fills (see <code>CONFIG_PAGING_TIMEOUT_TICKS</code>). - </li> - <li> - <code>CONFIG_PAGING_TIMEOUT_TICKS</code>: - If defined, the implementation will monitor the (asynchronous) page fill logic. - If the fill takes longer than this number if microseconds, then a fatal error will be declared. - Default: No timeouts monitored. - </li> - <p> - Some architecture-specific settings. - Defaults are architecture specific. - If you don't know what you are doing, it is best to leave these undefined and try the system defaults: - </p> - <li> - <code>CONFIG_PAGING_VECPPAGE</code>: - This the physical address of the page in memory to be mapped to the vector address. - </li> - <li> - <code>CONFIG_PAGING_VECL2PADDR</code>: - This is the physical address of the L2 page table entry to use for the vector mapping. - </li> - <li> - <code>CONFIG_PAGING_VECL2VADDR</code>: - This is the virtual address of the L2 page table entry to use for the vector mapping. - </li> - <li> - <code>CONFIG_PAGING_BINPATH</code>: - If <code>CONFIG_PAGING_BINPATH</code> is defined, then it is the full path to a file on a mounted file system that contains a binary image of the NuttX executable. - Pages will be filled by reading from offsets into this file that correspond to virtual fault addresses. - </li> - <li> - <code>CONFIG_PAGING_MOUNTPT</code>: - If <code>CONFIG_PAGING_BINPATH</code> is defined, additional options may be provided to control the initialization of underlying devices. - <code>CONFIG_PAGING_MOUNTPT</code> identifies the mountpoint to be used if a device is mounted. - </li> - <li> - <code>CONFIG_PAGING_MINOR</code>: - Some mount operations require a "minor" number to identify the specific device instance. - Default: 0 - </li> - <li> - <code>CONFIG_PAGING_SDSLOT</code>: - If <code>CONFIG_PAGING_BINPATH</code> is defined, additional options may be provided to control the initialization of underlying devices. - <code>CONFIG_PAGING_SDSLOT</code> identifies the slot number of the SD device to initialize. - This must be undefined if SD is not being used. - This should be defined to be zero for the typical device that has only a single slot (See <code>CONFIG_MMCSD_NSLOTS</code>). - If defined, <code>CONFIG_PAGING_SDSLOT</code> will instruct certain board-specific logic to initialize the media in this SD slot. - </li> - <li> - <code>CONFIG_PAGING_M25PX</code>: - Use the m25px.c FLASH driver. - If this is selected, then the MTD interface to the M25Px device will be used to support paging. - </li> - <li> - <code>CONFIG_PAGING_AT45DB</code>: - Use the at45db.c FLASH driver. - If this is selected, then the MTD interface to the Atmel AT45DB device will be used to support paging. - </li> - <li> - <code>CONFIG_PAGING_BINOFFSET</code>: - If CONFIG_PAGING_M25PX or CONFIG_PAGING_AT45DB is defined then CONFIG_PAGING_BINOFFSET will be used to specify the offset in bytes into the FLASH device where the NuttX binary image is located. - Default: 0 - </li> - <li> - <code>CONFIG_PAGING_SPIPORT</code>: - If CONFIG_PAGING_M25PX or CONFIG_PAGING_AT45DB is defined and the device has multiple SPI busses (ports), then this configuration should be set to indicate which SPI port the device is connected. - Default: 0 - </li> -</ul> -<p> - <b>Disabling OS Features</b>. - 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. -</p> -<p> - There are certain dependency relationships in these features. -</p> -<ul> - <li> - <code>mq_notify()</code> logic depends on signals to awaken tasks - waiting for queues to become full or empty. - </li> - <li> - <code>pthread_condtimedwait()</code> depends on signals to wake - up waiting tasks. - </li> -</ul> - -<ul> - <code>CONFIG_DISABLE_CLOCK</code>, <code>CONFI_DISABLE_POSIX_TIMERS</code>, - <code>CONFIG_DISABLE_PTHREAD</code>, <code>CONFIG_DISABLE_SIGNALS</code>, - <code>CONFIG_DISABLE_MQUEUE</code>, <code>CONFIG_DISABLE_MOUNTPOUNT</code> -</ul> - -<h2>Miscellaneous libc settings</h2> - -<ul> - <li> - <code>CONFIG_NOPRINTF_FIELDWIDTH</code>: <code>sprintf</code>-related logic is a - little smaller if we do not support fieldwidthes - </li> - <li> - <code>CONFIG_LIBC_FLOATINGPOINT</code>: By default, floating point - support in <code>printf</code>, <code>sscanf</code>, etc. is disabled. - </li> - <li> - <code>CONFIG_LIBC_STRERROR</code>: - <code>strerror()</code> is useful because it decodes <code>errno</code> values into a human readable strings. - But it can also require a lot of memory to store the strings. - If this option is selected, <code>strerror()</code> will still exist in the build but it will not decode error values. - This option should be used by other logic to decide if it should use <code>strerror()</code> or not. - For example, the NSH application will not use <code>strerror()</code> if this option is not selected; - <code>perror(</code>) will not use strerror() is this option is not selected (see also <code>CONFIG_NSH_STRERROR</code>). - </li> - <li> - <code>CONFIG_LIBC_STRERROR_SHORT</code>: - If this option is selected, then <code>strerror()</code> will use a shortened string when it decodes the error. - Specifically, <code>strerror()</code> is simply use the string that is the common name for the error. - For example, the <code>errno</code> value of 2 will produce the string "No such file or directory" if <code>CONFIG_LIBC_STRERROR_SHORT</code> is not defined but the string "ENOENT" if <code>CONFIG_LIBC_STRERROR_SHORT</code> is defined. - </li> - <li> - <code>CONFIG_LIBC_PERROR_STDOUT</code>: - POSIX requires that <code>perror()</code> provide its output on <code>stderr</code>. - This option may be defined, however, to provide <code>perror()</code> output that is serialized with other <code>stdout</code> messages. - </li> -</ul> - -<h2>Allow for architecture optimized implementations</h2> - -<ul> -<li> - The architecture can provide optimized versions of the following to improve system performance. -</li> -<ul><p> - <code>CONFIG_ARCH_MEMCPY</code>, <code>CONFIG_ARCH_MEMCMP</code>, <code>CONFIG_ARCH_MEMMOVE</code>, - <code>CONFIG_ARCH_MEMSET</code>, <code>CONFIG_ARCH_STRCMP</code>, <code>CONFIG_ARCH_STRCPY</code>, - <code>CONFIG_ARCH_STRNCPY</code>, <code>CONFIG_ARCH_STRLEN</code>, <code>CONFIG_ARCH_STRNLEN</code>, - <code>CONFIG_ARCH_BZERO</code> -</p></ul> - -<p><li> - If <code>CONFIG_ARCH_MEMCPY</code> is <b>not</b> selected, then you make also select Daniel - Vik's optimized implementation of <code>memcpy()</code>: -</p> -<ul><li> - <code>CONFIG_MEMCPY_VIK</code>: - Select this option to use the optimized <code>memcpy()</code> function by Daniel Vik. - Select this option for improved performance at the expense of increased size. - See licensing information in the top-level <code>COPYING</code> file. - Default: <code>n</code>. -</li></ul> - -<p> - And if <code>CONFIG_MEMCPY_VIK</code> is selected, the following tuning options are available: -</p> -<ul><li> - <code>CONFIG_MEMCPY_PRE_INC_PTRS</code>: - Use pre-increment of pointers. - Default is post increment of pointers. -</li> -<li> - <code>CONFIG_MEMCPY_INDEXED_COPY</code> - Copying data using array indexing. - Using this option, disables the <code>CONFIG_MEMCPY_PRE_INC_PTRS</code> option. -</li> -<li> - <code>CONFIG_MEMCPY_64BIT</code>: - Compiles <code>memcpy()</code> for 64 bit architectures -</li></ul> - -<p><li> - If <code>CONFIG_ARCH_MEMSET</code> is <b>not</b> selected, then the following option is also available: -</p> -<ul><li> - <code>CONFIG_MEMSET_OPTSPEED</code>: - Select this option to use a version of <code>memset()</code> optimized for speed. - Default: <code>memset()</code> is optimized for size. -</li></ul> - -<p> - And if <code>CONFIG_MEMSET_OPTSPEED</code> is selected, the following tuning option is available: -</p> -<ul><li> - <code>CONFIG_MEMSET_64BIT</code>: - Compiles <code>memset()</code> for 64 bit architectures -</li></ul> - -<li> - <p> - The architecture may provide custom versions of certain standard header files: - </p> - <ul> - <li><b><code>CONFIG_ARCH_STDBOOL_H</code></b>. - <p> - The <code>stdbool.h</code> header file can be found at <code>nuttx/include/stdbool.h</code>. - However, that header includes logic to redirect the inclusion of an architecture specific header file like: - </p> - <ul><pre> -#ifdef CONFIG_ARCH_STDBOOL_H -# include <arch/stdbool.h> -#else -... -#endif - </pre></ul> - <p> - Recall that that include path, <code>include/arch</code>, is a symbolic link and will refer to a version of <code>stdbool.h</code> at <code>nuttx/arch/<architecture>/include/stdbool.h</code>. - </p> - </li> - <li><b><code>CONFIG_ARCH_STDINT_H</code></b>. - <p> - Similar logic exists for the <code>stdint.h</code> header file can also be found at <code>nuttx/include/stdint.h</code>. - <ul><pre> -#ifdef CONFIG_ARCH_STDBOOL_H -# include <arch/stdinit.h> -#else -... -#endif - </pre></ul> - </p> - </li> - <li><b><code>CONFIG_ARCH_MATH_H</code></b>. - <p> - There is also a re-directing version of <code>math.h</code> in the source tree. However, it resides out-of-the-way at <code>include/nuttx/math.h</code> because it conflicts too often with the system <code>math.h</code>. - If <code>CONFIG_ARCH_MATH_H=y</code> is defined, however, the top-level makefile will copy the redirecting <code>math.h</code> header file from <code>include/nuttx/math.h</code> to <code>include/math.h</code>. - <code>math.h</code> will then include the architecture-specific version of <code>math.h</code> that you must provide at <code>nuttx/arch/<architecture>/include/math.h</code>. - </p> - <ul><pre> -#ifdef CONFIG_ARCH_MATH_H -# include <arch/math.h> -#endif - </pre></ul> - <p> - So for the architectures that define <code>CONFIG_ARCH_MATH_H=y</code>, <code>include/math.h</code> will be the redirecting <code>math.h</code> header file; for the architectures that don't select <code>CONFIG_ARCH_MATH_H</code>, the redirecting <code>math.h</code> header file will stay out-of-the-way in <code>include/nuttx/</code>. - </p> - </li> - <li><b><code>CONFIG_ARCH_FLOAT_H</code></b>. - <p> - If you enable the generic, built-in math library, then that math library will expect your toolchain to provide the standard <code>float.h</code> header file. - The <code>float.h</code> header file defines the properties of your floating point implementation. - It would always be best to use your toolchain's <code>float.h</code> header file but if none is avaiable, a default <code>float.h</code> header file will provided if this option is selected. - However, there is no assurance that the settings in this float.h are actually correct for your platform! - </p> - </li> - <li><b><code>CONFIG_ARCH_STDARG_H</code></b>. - <p> - There is also a redirecting version of <code>stdarg.h</code> in the source tree as well. - It also resides out-of-the-way at <code>include/nuttx/stdarg.h</code>. - This is because you should normally use your toolchain's <code>stdarg.h</code> file. - But sometimes, your toolchain's <code>stdarg.h</code> file may have other header file dependencies and so may not be usable in the NuttX build environment. - In those cases, you may have to create a architecture-specific <code>stdarg.h</code> header file at <code>nuttx/arch/<architecture>/include/stdarg.h</code> - </p> - <p> - If <code>CONFIG_ARCH_STDARG_H=y</code> is defined, the top-level makefile will copy the re-directing <code>stdarg.h</code> header file from <code>include/nuttx/stdarg.h</code> to <code>include/stdarg.h</code>. - So for the architectures that cannot use their toolchain's <code>stdarg.h</code> file, they can use this alternative by defining <code>CONFIG_ARCH_STDARG_H=y</code> and providing. - If <code>CONFIG_ARCH_STDARG_H</code>, is not defined, then the <code>stdarg.h</code> header file will stay out-of-the-way in <code>include/nuttx/.</code> - </p> - </li> - </ul> -</li> - -<li> - <p><code>CONFIG_ARCH_ROMGETC</code>: - There are cases where string data cannot be cannot be accessed by simply de-referencing a string pointer. - As examples: - </p> - <ul> - <li> - In Harvard architectures, data accesses and instruction accesses occur on different busses, perhaps concurrently. - All data accesses are performed on the data bus unless special machine instructions are used to read data from the instruction address space. - Also, in the typical MCU, the available SRAM data memory is much smaller that the non-volatile FLASH instruction memory. - So if the application requires many constant strings, the only practical solution may be to store those constant strings in FLASH memory where they can only be accessed using architecture-specific machine instructions. - </li> - <li> - A similar case is where strings are retained in "external" memory such as EEPROM or serial FLASH. - This case is similar only in that again special operations are required to obtain the string data; - it cannot be accessed directly from a string pointer. - </li> - </ul> - <p> - If <code>CONFIG_ARCH_ROMGETC</code> is defined, then the architecture-specific logic must export the function <code>up_romgetc()</code>. - <code>up_romgetc()</code> will simply read one byte of data from the instruction space. - </p> - <p> - If <code>CONFIG_ARCH_ROMGETC</code>, certain C stdio functions are effected: - (1) All format strings in <code>printf</code>, <code>fprintf</code>, <code>sprintf</code>, etc. are assumed to lie in FLASH - (string arguments for <code>%s</code> are still assumed to reside in SRAM). - And (2), the string argument to <code>puts</code> and <code>fputs</code> is assumed to reside in FLASH. - Clearly, these assumptions may have to modified for the particular needs of your environment. - There is no "one-size-fits-all" solution for this problem. - </p> -</ul> - -<h2>Sizes of configurable things (0 disables)</h2> - -<ul> - <li> - <code>CONFIG_MAX_TASKS</code>: The maximum number of simultaneously - active tasks. This value must be a power of two. - </li> - <li> - <code>CONFIG_NPTHREAD_KEYS</code>: The number of items of thread- - specific data that can be retained - </li> - <li> - <code>CONFIG_NFILE_DESCRIPTORS</code>: The maximum number of file - descriptors (one for each open) - </li> - <li> - <code>CONFIG_NFILE_STREAMS</code>: The maximum number of streams that - can be fopen'ed - </li> - <li> - <code>CONFIG_NAME_MAX</code>: Maximum number of bytes in a filename (not including terminating null). - Default: 32 - </li> - <li> - <code>CONFIG_PATH_MAX</code>: Maximum number of bytes in a pathname, including the terminating null character. - Default: <code>MIN(256,(4*CONFIG_NAME_MAX+1))</code> - </li> - <li> - <code>CONFIG_STDIO_BUFFER_SIZE</code>: Size of the buffer to allocate - on fopen. (Only if CONFIG_NFILE_STREAMS > 0) - </li> - <li> - <code>CONFIG_STDIO_LINEBUFFER</code>: - If standard C buffered I/O is enabled (<code>CONFIG_STDIO_BUFFER_SIZE</code> > 0), - then this option may be added to force automatic, line-oriented flushing the output buffer - for <code>putc()</code>, <code>fputc()</code>, <code>putchar()</code>, <code>puts()</code>, <code>fputs()</code>, - <code>printf()</code>, <code>fprintf()</code>, and <code>vfprintf()</code>. - When a newline character is encountered in the output string, the output buffer will be flushed. - This (slightly) increases the NuttX footprint but supports the kind of behavior that people expect for <code>printf()</code>. - <li> - <code>CONFIG_NUNGET_CHARS</code>: Number of characters that can be - buffered by ungetc() (Only if CONFIG_NFILE_STREAMS > 0) - </li> - <li> - <code>CONFIG_PREALLOC_MQ_MSGS</code>: The number of pre-allocated message - structures. The system manages a pool of preallocated - message structures to minimize dynamic allocations - </li> - <li> - <code>CONFIG_MQ_MAXMSGSIZE</code>: Message structures are allocated with - a fixed payload size given by this setting (does not include - other message structure overhead. - </li> - <li> - <code>CONFIG_PREALLOC_WDOGS</code>: The number of pre-allocated watchdog - structures. The system manages a pool of preallocated - watchdog structures to minimize dynamic allocations - </li> - <li> - <code>CONFIG_PREALLOC_IGMPGROUPS</code>: Pre-allocated IGMP groups are used - Only if needed from interrupt level group created (by the IGMP server). - Default: 4 - </li> - <li> - <code>CONFIG_DEV_PIPE_SIZE</code>: Size, in bytes, of the buffer to allocated - for pipe and FIFO support (default is 1024). - </li> -</ul> - -<h2>File Systems</h2> -<ul> - <li> - <code>CONFIG_FS_FAT</code>: Enable FAT file system support. - </li> - <li> - <code>CONFIG_FAT_LCNAMES</code>: Enable use of the NT-style upper/lower case 8.3 file name support. - </li> - <li> - <code>CONFIG_FAT_LFN</code>: Enable FAT long file names. - NOTE: Microsoft claims patents on FAT long file name technology. - Please read the disclaimer in the top-level COPYING file and only enable this feature if you understand these issues. - </li> - <li> - <code>CONFIG_FAT_MAXFNAME</code>: If <code>CONFIG_FAT_LFN</code> is defined, then the default, maximum long file name is 255 bytes. - This can eat up a lot of memory (especially stack space). - If you are willing to live with some non-standard, short long file names, then define this value. - A good choice would be the same value as selected for CONFIG_NAME_MAX which will limit the visibility of longer file names anyway. - </li> - <li> - <code>CONFIG_FS_FATTIME</code>: Support FAT date and time. - NOTE: There is not much sense in supporting FAT date and time unless you have a hardware RTC - or other way to get the time and date. - </li> - <li> - <code>CONFIG_FS_NXFFS</code>: Enable NuttX FLASH file system (NXFF) support. - </li> - <li> - <code>CONFIG_NXFFS_ERASEDSTATE</code>: The erased state of FLASH. - This must have one of the values of <code>0xff</code> or <code>0x00</code>. - Default: <code>0xff</code>. - </li> - <li> - <code>CONFIG_NXFFS_PACKTHRESHOLD</code>: When packing flash file data, - don't both with file chunks smaller than this number of data bytes. - Default: 32. - </li> - <li> - <code>CONFIG_NXFFS_MAXNAMLEN</code>: The maximum size of an NXFFS file name. - Default: 255. - </li> - <li> - <code>CONFIG_NXFFS_PACKTHRESHOLD</code>: When packing flash file data, - don't both with file chunks smaller than this number of data bytes. - Default: 32. - </li> - <li> - <code>CONFIG_NXFFS_TAILTHRESHOLD</code>: clean-up can either mean - packing files together toward the end of the file or, if file are - deleted at the end of the file, clean up can simply mean erasing - the end of FLASH memory so that it can be re-used again. However, - doing this can also harm the life of the FLASH part because it can - mean that the tail end of the FLASH is re-used too often. This - threshold determines if/when it is worth erased the tail end of FLASH - and making it available for re-use (and possible over-wear). - Default: 8192. - </li> - <li> - <code>CONFIG_FS_ROMFS</code>: Enable ROMFS file system support - </li> - <li> - <code>CONFIG_NFS</code>: Enable Network File System (NFS) client file system support. - Provided support is version 3 using UDP. - In addition to common prerequisites for mount-able file systems in general, - this option requires UDP networking support; - this would include <code>CONFIG_NET</code> and <code>CONFIG_NET_UDP</code> at a minimum. - </li> - <li> - <code>CONFIG_FS_RAMMAP</code>: For file systems that do not support - XIP, this option will enable a limited form of memory mapping that is - implemented by copying whole files into memory. - </li> -</ul> - -<h2>Device Drivers</h2> -<h3>RTC</h3> -<ul> - <li> - <code>CONFIG_RTC</code>: - Enables general support for a hardware RTC. - Specific architectures may require other specific settings. - </li> - <li> - <code>CONFIG_RTC_DATETIME</code>: - There are two general types of RTC: (1) A simple battery backed counter that keeps the time when power - is down, and (2) A full date / time RTC the provides the date and time information, often in BCD format. - If <code>CONFIG_RTC_DATETIME</code> is selected, it specifies this second kind of RTC. - In this case, the RTC is used to "seed"" the normal NuttX timer and the NuttX system timer - provides for higher resoution time. - </li> - <li> - <code>CONFIG_RTC_HIRES</code>: - If <code>CONFIG_RTC_DATETIME</code> not selected, then the simple, battery backed counter is used. - There are two different implementations of such simple counters based on the time resolution of the counter: - The typical RTC keeps time to resolution of 1 second, usually supporting a 32-bit <code>time_t</code> value. - In this case, the RTC is used to "seed" the normal NuttX timer and the NuttX timer provides for higher resoution time. - If <code>CONFIG_RTC_HIRES</code> is enabled in the NuttX configuration, then the RTC provides higher resolution time and completely replaces the system timer for purpose of date and time. - </li> - <li> - <code>CONFIG_RTC_FREQUENCY</code>: - If <code>CONFIG_RTC_HIRES</code> is defined, then the frequency of the high resolution RTC must be provided. - If <code>CONFIG_RTC_HIRES</code> is not defined, <code>CONFIG_RTC_FREQUENCY</code> is assumed to be one. - </li> - <li> - <code>CONFIG_RTC_ALARM</code>: - Enable if the RTC hardware supports setting of an alarm. - A callback function will be executed when the alarm goes off - </li> -</ul> - -<h3>CAN driver</h3> -<ul> - <li> - <code>CONFIG_CAN</code>: Enables CAN support - </li> - <li> - <code>CONFIG_CAN_FIFOSIZE</code>: The size of the circular buffer of CAN messages. Default: 8 - </li> - <li> - <code>CONFIG_CAN_NPENDINGRTR</code>: The size of the list of pending RTR requests. Default: 4 - </li> - <li> - <code>CONFIG_CAN_LOOPBACK</code>: A CAN driver may or may not support a loopback mode for testing. - If the driver does support loopback mode, the setting will enable it. - (If the driver does not, this setting will have no effect). - </li> -</ul> - -<h3>SPI driver</h3> -<ul> - <li> - <code>CONFIG_SPI_OWNBUS</code>: Set if there is only one active device - on the SPI bus. No locking or SPI configuration will be performed. - It is not necessary for clients to lock, re-configure, etc.. - </li> - <li> - <code>CONFIG_SPI_EXCHANGE</code>: Driver supports a single exchange method - (vs a recvblock() and sndblock ()methods) - </li> -</ul> - -<h3>SPI-based MMC/SD driver</h3> -<ul> - <li> - <code>CONFIG_MMCSD_NSLOTS</code>: Number of MMC/SD slots supported by the driver. Default is one. - </li> - <li> - <code>CONFIG_MMCSD_READONLY</code>: Provide read-only access. Default is Read/Write - </li> - <li> - <code>CONFIG_MMCSD_SPICLOCK</code>: Maximum SPI clock to drive MMC/SD card. Default is 20MHz. - </li> -</ul> - -<h3>SDIO/SDHC driver</h3> -<ul> - <li> - <code>CONFIG_SDIO_DMA</code>: SDIO driver supports DMA - </li> - <li> - <code>CONFIG_SDIO_MUXBUS</code>: Set this SDIO interface if the SDIO interface - or hardware resources are shared with other drivers. - </li> - <li> - <code>CONFIG_SDIO_WIDTH_D1_ONLY</code>: Select 1-bit transfer mode. Default: - 4-bit transfer mode. - </li> - <li> - <code>CONFIG_MMCSD_MULTIBLOCK_DISABLE</code>: Use only the single block transfer method. - This setting is used to work around buggy SDIO drivers that cannot handle - multiple block transfers. - </li> -</ul> - -<h3>SDIO-based MMC/SD driver</h3> -<ul> - <li> - <code>CONFIG_FS_READAHEAD</code>: Enable read-ahead buffering - </li> - <li> - <code>CONFIG_FS_WRITEBUFFER</code>: Enable write buffering - </li> - <li> - <code>CONFIG_SDIO_DMA</code>: SDIO driver supports DMA - </li> - <li> - <code>CONFIG_MMCSD_MMCSUPPORT</code>: Enable support for MMC cards - </li> - <li> - <code>CONFIG_MMCSD_HAVECARDDETECT</code>: SDIO driver card detection is 100% accurate - </li> -</ul> - -<h3>RiT P14201 OLED driver</h3> -<ul> - <li> - <code>CONFIG_LCD_P14201</code>: Enable P14201 support - </li> - <li> - <code>CONFIG_P14201_SPIMODE</code>: Controls the SPI mode - </li> - <li> - <code>CONFIG_P14201_FREQUENCY</code>: Define to use a different bus frequency - </li> - <li> - <code>CONFIG_P14201_NINTERFACES</code>: - Specifies the number of physical P14201 devices that will be supported. - </li> - <li> - <code>CONFIG_P14201_FRAMEBUFFER</code>: - If defined, accesses will be performed using an in-memory copy of the OLEDs GDDRAM. - This cost of this buffer is 128 * 96 / 2 = 6K. - If this is defined, then the driver will be fully functional. - If not, then it will have the following limitations: - <ul> - <li>Reading graphics memory cannot be supported, and</li> - <li>All pixel writes must be aligned to byte boundaries.</li> - </ul> - The latter limitation effectively reduces the 128x96 disply to 64x96. - </li> -</ul> - -<h3>Nokia 6100 Configuration Settings:</h3> -<ul> - <li> - <code>CONFIG_NOKIA6100_SPIMODE</code>: Controls the SPI mode, - </li> - <li> - <code>CONFIG_NOKIA6100_FREQUENCY</code>: Define to use a different bus frequency. - </li> - <li> - <code>CONFIG_NOKIA6100_NINTERFACES</code>:Specifies the number of physical Nokia - 6100 devices that will be supported. - </li> - <li> - <code>CONFIG_NOKIA6100_BPP</code>: Device supports 8, 12, and 16 bits per pixel. - </li> - <li> - <code>CONFIG_NOKIA6100_S1D15G10</code>: Selects the Epson S1D15G10 display controller - </li> - <li> - <code>CONFIG_NOKIA6100_PCF8833</code>: Selects the Phillips PCF8833 display controller - </li> - <li> - <code>CONFIG_NOKIA6100_BLINIT</code>: Initial backlight setting - </li> - <p> - The following may need to be tuned for your hardware: - </p> - <li> - <code>CONFIG_NOKIA6100_INVERT</code>: Display inversion, 0 or 1, Default: 1 - </li> - <li> - <code>CONFIG_NOKIA6100_MY</code>: Display row direction, 0 or 1, Default: 0 - </li> - <li> - <code>CONFIG_NOKIA6100_MX</code>: Display column direction, 0 or 1, Default: 1 - </li> - <li> - <code>CONFIG_NOKIA6100_V</code>: Display address direction, 0 or 1, Default: 0 - </li> - <li> - <code>CONFIG_NOKIA6100_ML</code>: Display scan direction, 0 or 1, Default: 0 - </li> - <li> - <code>CONFIG_NOKIA6100_RGBORD</code>: Display RGB order, 0 or 1, Default: 0 - </li> - <p> - Required LCD driver settings: - </p> - <li> - <code>CONFIG_LCD_NOKIA6100</code>: Enable Nokia 6100 support - </li> - <li> - <code>CONFIG_LCD_MAXCONTRAST</code>: Must be 63 with the Epson controller and 127 with - the Phillips controller. - </li> - <li> - <code>CONFIG_LCD_MAXPOWER</code>:Maximum value of backlight setting. The backlight - control is managed outside of the 6100 driver so this value has no - meaning to the driver. Board-specific logic may place restrictions on - this value. - </li> -</ul> - -<h3>Input Devices</h3> -<ul> - <li> - <code>CONFIG_INPUT</code>: - Enables general support for input devices - </li> - <li> - <code>CONFIG_INPUT_TSC2007</code>: - If CONFIG_INPUT is selected, then this setting will enable building - of the TI TSC2007 touchscreen driver. - </li> - <li> - <code>CONFIG_TSC2007_MULTIPLE</code>: - Normally only a single TI TSC2007 touchscreen is used. But if - there are multiple TSC2007 touchscreens, this setting will enable - multiple touchscreens with the same driver. - </li> - <li> - <code>CONFIG_INPUT_STMPE811</code>: - Enables support for the STMPE811 driver (Needs <code>CONFIG_INPUT</code>) - </li> - <li> - <code>CONFIG_STMPE811_SPI</code>: - Enables support for the SPI interface (not currenly supported) - </li> - <li> - <code>CONFIG_STMPE811_I2C</code>: - Enables support for the I2C interface - </li> - <li> - <code>CONFIG_STMPE811_MULTIPLE </code>: - Can be defined to support multiple STMPE811 devices on board. - </li> - <li> - <code>CONFIG_STMPE811_ACTIVELOW</code>: - Interrupt is generated by an active low signal (or falling edge). - </li> - <li> - <code>CONFIG_STMPE811_EDGE</code>: - Interrupt is generated on an edge (vs. on the active level) - </li> - <li> - <code>CONFIG_STMPE811_NPOLLWAITERS</code>: - Maximum number of threads that can be waiting on poll() (ignored if - <code>CONFIG_DISABLE_POLL</code> is set). - </li> - <li> - <code>CONFIG_STMPE811_TSC_DISABLE</code>: - Disable driver touchscreen functionality. - </li> - <li> - <code>CONFIG_STMPE811_ADC_DISABLE</code>: - Disable driver ADC functionality. - </li> - <li> - <code>CONFIG_STMPE811_GPIO_DISABLE</code>: - Disable driver GPIO functionlaity. - </li> - <li> - <code>CONFIG_STMPE811_GPIOINT_DISABLE</code>: - Disable driver GPIO interrupt functionality (ignored if GPIO - functionality is disabled). - </li> - <li> - <code>CONFIG_STMPE811_SWAPXY</code>: - Reverse the meaning of X and Y to handle different LCD orientations. - </li> - <li> - <code>CONFIG_STMPE811_TEMP_DISABLE</code>: - Disable driver temperature sensor functionality. - </li> - <li> - <code>CONFIG_STMPE811_REGDEBUG</code>: - Enabled very low register-level debug output. Requires <code>CONFIG_DEBUG</code>. - </li> - <li> - <code>CONFIG_STMPE811_THRESHX</code> and <code>CONFIG_STMPE811_THRESHY</code>: - STMPE811 touchscreen data comes in a a very high rate. New touch positions - will only be reported when the X or Y data changes by these thresholds. - This trades reduces data rate for some loss in dragging accuracy. The - STMPE811 is configure for 12-bit values so the raw ranges are 0-4095. So - for example, if your display is 320x240, then THRESHX=13 and THRESHY=17 - would correspond to one pixel. Default: 12 - </li> -</ul> - -<h3>Analog Devices</h3> -<ul> - <li> - <code>CONFIG_DAC</code>: - Enables general support for Digital-to-Analog conversion devices. - </li> - <li> - <code>CONFIG_ADC</code>: - Enables general support for Analog-to-Digital conversion devices. - </li> - <li> - <code>CONFIG_ADC_ADS125X</code>: - Adds support for the TI ADS 125x ADC. - </li> -</ul> - -<h3>ENC28J60 Ethernet Driver Configuration Settings</h3> -<ul> - <li> - <code>CONFIG_ENC28J60</code>: Enabled ENC28J60 support - </li> - <li> - <code>CONFIG_ENC28J60_SPIMODE</code>: Controls the SPI mode - </li> - <li> - <code>CONFIG_ENC28J60_FREQUENCY</code>: Define to use a different bus frequency - </li> - <li> - <code>CONFIG_ENC28J60_NINTERFACES</code>: - Specifies the number of physical ENC28J60 devices that will be supported. - </li> - <li> - <code>CONFIG_ENC28J60_STATS</code>: Collect network statistics - </li> - <li> - <code>CONFIG_ENC28J60_HALFDUPPLEX</code>: Default is full duplex - </li> -</ul> - -<h2>Network Support</h2> -<h3>TCP/IP and UDP support via uIP</h3> -<ul> - <li> - <code>CONFIG_NET</code>: Enable or disable all network features - </li> - <li> - <code>CONFIG_NET_SLIP</code>: Selects the Serial Line Internet Protocol (SLIP) data link layer. - (This selection is discussed further <a href="#slipdriver">below</a>). - </li> - <li> - <code>CONFIG_NET_NOINTS</code>: <code>CONFIG_NET_NOINT</code> indicates that uIP not called from the interrupt level. - If <code>CONFIG_NET_NOINTS</code> is defined, critical sections will be managed with semaphores; - Otherwise, it assumed that uIP will be called from interrupt level handling and critical sections will be managed by enabling and disabling interrupts. - </li> - <li> - <code>CONFIG_NET_MULTIBUFFER</code>: Traditionally, uIP has used a single buffer for all incoming and outgoing traffic. - If this configuration is selected, then the driver can manage multiple I/O buffers and can, for example, be filling one input buffer while sending another output buffer. - Or, as another example, the driver may support queuing of concurrent input/ouput and output transfers for better performance. - </li> - <li> - <code>CONFIG_NET_IPv6</code>: Build in support for IPv6 - </li> - <li> - <code>CONFIG_NSOCKET_DESCRIPTORS</code>: Maximum number of socket descriptors per task/thread. - </li> - <li> - <code>CONFIG_NET_NACTIVESOCKETS</code>: Maximum number of concurrent socket operations (recv, send, etc.). - Default: <code>CONFIG_NET_TCP_CONNS</code>+<code>CONFIG_NET_UDP_CONNS</code>. - </li> - <li> - <code>CONFIG_NET_SOCKOPTS</code>: Enable or disable support for socket options. - </li> - <li> - <code>CONFIG_NET_BUFSIZE</code>: uIP buffer size - </li> - <li> - <code>CONFIG_NET_TCP</code>: TCP support on or off - </li> - <li> - <code>CONFIG_NET_TCP_CONNS</code>: Maximum number of TCP connections (all tasks). - </li> - <li> - <code>CONFIG_NET_TCPBACKLOG</code>: - Incoming connections pend in a backlog until <code>accept()</code> is called. - The size of the backlog is selected when <code>listen()</code> is called. - </li> - <li> - <code>CONFIG_NET_TCP_READAHEAD_BUFSIZE</code>: Size of TCP read-ahead buffers - </li> - <li> - <code>CONFIG_NET_NTCP_READAHEAD_BUFFERS</code>: Number of TCP read-ahead buffers (may be zero to disable TCP/IP read-ahead buffering) - </li> - <li> - <code>CONFIG_NET_TCP_RECVDELAY</code>: Delay (in deciseconds) after a TCP/IP packet is received. - This delay may allow catching of additional packets when TCP/IP read-ahead is disabled. - Default: 0 - </li> - <li> - <code>CONFIG_NET_MAX_LISTENPORTS</code>: Maximum number of listening TCP ports (all tasks). - </li> - <li> - <code>CONFIG_NET_TCPURGDATA</code>: Determines if support for TCP urgent data - notification should be compiled in. Urgent data (out-of-band data) - is a rarely used TCP feature that is very seldom would be required. - </li> - <li> - <code>CONFIG_NET_UDP</code>: UDP support on or off - </li> - <li> - <code>CONFIG_NET_UDP_CHECKSUMS</code>: UDP checksums on or off - </li> - <li> - <code>CONFIG_NET_UDP_CONNS</code>: The maximum amount of concurrent UDP connections - </li> - <li> - <code>CONFIG_NET_ICMP</code>: Enable minimal ICMP support. Includes built-in support - for sending replies to received ECHO (ping) requests. - </li> - <li> - <code>CONFIG_NET_ICMP_PING</code>: Provide interfaces to support application level - support for sending ECHO (ping) requests and associating ECHO replies. - </li> - <li> - <code>CONFIG_NET_IGMP</code>: Enable IGMPv2 client support. - </li> - <li> - <code>CONFIG_PREALLOC_IGMPGROUPS</code>: Pre-allocated IGMP groups are used - Only if needed from interrupt level group created (by the IGMP server). - Default: 4 - </li> - <li> - <code>CONFIG_NET_PINGADDRCONF</code>: Use "ping" packet for setting IP address - </li> - <li> - <code>CONFIG_NET_STATISTICS</code>: uIP statistics on or off - </li> - <li> - <code>CONFIG_NET_RECEIVE_WINDOW</code>: The size of the advertised receiver's window - </li> - <li> - <code>CONFIG_NET_ARPTAB_SIZE</code>: The size of the ARP table - </li> - <li> - <code>CONFIG_NET_ARP_IPIN</code>: Harvest IP/MAC address mappings for the ARP table from incoming IP packets. - </li> - <li> - <code>CONFIG_NET_BROADCAST</code>: Incoming UDP broadcast support - </li> - <li> - <code>CONFIG_NET_MULTICAST</code>: Outgoing multi-cast address support - </li> -</ul> - -<h3><a name="slipdriver">SLIP</a></h3> <p> - The NuttX SLIP driver supports point-to-point IP communications over a serial port. - The default data link layer for uIP is Ethernet. - If <code>CONFIG_NET_SLIP</code> 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: - <ul> - <li>The link level header (that comes before the IP header) is omitted.</li> - <li>All MAC address processing is suppressed.</li> - <li>ARP is disabled.</li> - </ul> - If <code>CONFIG_NET_SLIP</code> 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). -</p> -<ul> - <li> - <code>CONFIG_NET_SLIP</code>: Enables building of the SLIP driver. - SLIP requires at least one IP protocols selected and the following additional network settings: <code>CONFIG_NET_NOINTS</code> and <code>CONFIG_NET_MULTIBUFFER</code>. - <code>CONFIG_NET_BUFSIZE</code> <i>must</i> be set to 296. - Other optional configuration settings that affect the SLIP driver: <code>CONFIG_NET_STATISTICS</code>. - Default: Ethernet. - </li> - <p> - If SLIP is selected, then the following SLIP options are available: - </p> - <li> - <code>CONFIG_CLIP_NINTERFACES</code>: Selects the number of physical SLIP interfaces to support. Default: 1 - </li> - <li> - <code>CONFIG_SLIP_STACKSIZE</code>: Select the stack size of the SLIP RX and TX tasks. Default: 2048 - </li> - <li> - <code>CONFIG_SLIP_DEFPRIO</code>: The priority of the SLIP RX and TX tasks. Default: 128 - </li> - </li> -</ul> - -<h3>UIP Network Utilities</h3> -<ul> - <li> - <code>CONFIG_NET_DHCP_LIGHT</code>: Reduces size of DHCP - </li> - <li> - <code>CONFIG_NET_RESOLV_ENTRIES</code>: Number of resolver entries - </li> - <li> - <code>CONFIG_NET_RESOLV_MAXRESPONSE</code>: - This setting determines the maximum size of response message that can be received by the DNS resolver. - The default is 96 but may need to be larger on enterprise networks (perhaps 176). - </li> -</ul> - -<h3>THTTPD</h3> -<ul> - <li> - <code>CONFIG_THTTPD_PORT</code>: THTTPD Server port number - </li> - <li> - <code>CONFIG_THTTPD_IPADDR</code>: Server IP address (no host name) - </li> - <li> - <code>CONFIG_THTTPD_SERVER_ADDRESS</code>: SERVER_ADDRESS: response - </li> - <li> - <code>CONFIG_THTTPD_SERVER_SOFTWARE</code>: SERVER_SOFTWARE: response - </li> - <li> - <code>CONFIG_THTTPD_PATH</code>: Server working directory. Default: <code>/mnt/www</code>. - </li> - <li> - <code>CONFIG_THTTPD_CGI_PATH</code>: Path to CGI executables. Default: <code>/mnt/www/cgi-bin</code>. - </li> - <li> - <code>CONFIG_THTTPD_CGI_PATTERN</code>: Only CGI programs whose expanded paths - match this pattern will be executed. In fact, if this value is not defined - then no CGI logic will be built. Default: <code>/mnt/www/cgi-bin/*</code>. - </li> - <li> - <code>CONFIG_THTTPD_CGI_PRIORITY</code>: Provides the priority of CGI child tasks - </li> - <li> - <code>CONFIG_THTTPD_CGI_STACKSIZE</code>: Provides the initial stack size of - CGI child task (will be overridden by the stack size in the NXFLAT - header) - </li> - <li> - <code>CONFIG_THTTPD_CGI_BYTECOUNT</code>: Byte output limit for CGI tasks. - </li> - <li> - <code>CONFIG_THTTPD_CGI_TIMELIMIT</code>: How many seconds to allow CGI programs - to run before killing them. - </li> - <li> - <code>CONFIG_THTTPD_CHARSET</code>: The default character set name to use with - text MIME types. - </li> - <li> - <code>CONFIG_THTTPD_IOBUFFERSIZE</code>: - </li> - <li> - <code>CONFIG_THTTPD_INDEX_NAMES</code>: A list of index filenames to check. The - files are searched for in this order. - </li> - <li> - <code>CONFIG_AUTH_FILE</code>: The file to use for authentication. If this is - defined then thttpd checks for this file in the local directory - before every fetch. If the file exists then authentication is done, - otherwise the fetch proceeds as usual. If you leave this undefined - then thttpd will not implement authentication at all and will not - check for auth files, which saves a bit of CPU time. A typical - value is ".htpasswd&quout; - </li> - <li> - <code>CONFIG_THTTPD_LISTEN_BACKLOG</code>: The listen() backlog queue length. - </li> - <li> - <code>CONFIG_THTTPD_LINGER_MSEC</code>: How many milliseconds to leave a connection - open while doing a lingering close. - </li> - <li> - <code>CONFIG_THTTPD_OCCASIONAL_MSEC</code>: How often to run the occasional - cleanup job. - </li> - <li> - <code>CONFIG_THTTPD_IDLE_READ_LIMIT_SEC</code>: How many seconds to allow for - reading the initial request on a new connection. - </li> - <li> - <code>CONFIG_THTTPD_IDLE_SEND_LIMIT_SEC</code>: How many seconds before an - idle connection gets closed. - </li> - <li> - <code>CONFIG_THTTPD_TILDE_MAP1 and CONFIG_THTTPD_TILDE_MAP2</code>: Tilde mapping. - Many URLs use ~username to indicate a user's home directory. thttpd - provides two options for mapping this construct to an actual filename. - <ol> - <li> - Map ~username to <prefix>/username. This is the recommended choice. - Each user gets a subdirectory in the main web tree, and the tilde - construct points there. The prefix could be something like "users", - or it could be empty. - </li> - <li> - Map ~username to <user's homedir>/<postfix>. The postfix would be - the name of a subdirectory off of the user's actual home dir, - something like "public_html". - </li> - </ol> - You can also leave both options undefined, and thttpd will not do - anything special about tildes. Enabling both options is an error. - Typical values, if they're defined, are "users" for - CONFIG_THTTPD_TILDE_MAP1 and "public_html" forCONFIG_THTTPD_TILDE_MAP2. - </li> - <li> - <code>CONFIG_THTTPD_GENERATE_INDICES</code>: - </li> - <li> - <code>CONFIG_THTTPD_URLPATTERN</code>: If defined, then it will be used to match - and verify referrers. - </li> -</ul> - -<h3>FTP Server</h3> -<ul> - <li> - <code>CONFIG_FTPD_VENDORID</code>: The vendor name to use in FTP communications. Default: "NuttX" - </li> - <li> - <code>CONFIG_FTPD_SERVERID</code>: The server name to use in FTP communications. Default: "NuttX FTP Server" - </li> - <li> - <code>CONFIG_FTPD_CMDBUFFERSIZE</code>: The maximum size of one command. Default: 128 bytes. - </li> - <li> - <code>CONFIG_FTPD_DATABUFFERSIZE</code>: The size of the I/O buffer for data transfers. Default: 512 bytes. - </li> - <li> - <code>CONFIG_FTPD_WORKERSTACKSIZE</code>: The stacksize to allocate for each FTP daemon worker thread. Default: 2048 bytes. - </li> -</ul> -<p> - Other required FTPD configuration settings: Of course TCP networking support is required. But here are a couple that are less obvious: -</p> -<ul> - <li> - <code>CONFIG_DISABLE_PTHREAD=n</code>: pthread support is required - </li> - <li> - <code>CONFIG_DISABLE_POLL=n</code>: poll() support is required - </li> -</ul> - -<h2>USB Device-Side Support</h2> -<h3>USB Device Controller Driver</h3> -<ul> - <li> - <code>CONFIG_USBDEV</code>: Enables USB device support - </li> - <li> - <code>CONFIG_USBDEV_COMPOSITE</code>: Enables USB composite device support - </li> - <li> - <code>CONFIG_USBDEV_ISOCHRONOUS</code>: Build in extra support for isochronous endpoints - </li> - <li> - <code>CONFIG_USBDEV_DUALSPEED</code>: Hardware handles high and full speed operation (USB 2.0) - </li> - <li> - <code>CONFIG_USBDEV_SELFPOWERED</code>: Will cause USB features to indicate that the device is self-powered - </li> - <li> - <code>CONFIG_USBDEV_MAXPOWER</code>: Maximum power consumption in mA - </li> - <li> - <code>CONFIG_USBDEV_TRACE</code>: Enables USB tracing for debug - </li> - <li> - <code>CONFIG_USBDEV_TRACE_NRECORDS</code>: Number of trace entries to remember - </li> -</ul> - -<h3>USB Serial Device Class Driver (Prolific PL2303 Emulation)</h3> -<ul> - <li> - <code>CONFIG_PL2303</code>: Enable compilation of the USB serial driver - </li> - <li> - <code>CONFIG_PL2303_EPINTIN</code>: The logical 7-bit address of a hardware endpoint that supports interrupt IN operation - </li> - <li> - <code>CONFIG_PL2303_EPBULKOUT</code>: The logical 7-bit address of a hardware endpoint that supports bulk OUT operation - </li> - <li> - <code>CONFIG_PL2303_EPBULKIN</code>: The logical 7-bit address of a hardware endpoint that supports bulk IN operation - </li> - <li> - <code>CONFIG_PL2303_NWRREQS</code> and <code>CONFIG_PL2303_NRDREQS</code>: The number of write/read requests that can be in flight - </li> - <li> - <code>CONFIG_PL2303_VENDORID</code> and <code>CONFIG_PL2303_VENDORSTR</code>: The vendor ID code/string - </li> - <li> - <code>CONFIG_PL2303_PRODUCTID</code> and <code>CONFIG_PL2303_PRODUCTSTR</code>: The product ID code/string - </li> - <li> - <code>CONFIG_PL2303_RXBUFSIZE</code> and <code>CONFIG_PL2303_TXBUFSIZE</code>: Size of the serial receive/transmit buffers - </li> -</ul> - -<h3>USB serial device class driver (Standard CDC ACM class)</h3> -<ul> - <li> - <code>CONFIG_CDCACM</code>: Enable compilation of the USB serial driver - </li> - <li> - <code>CONFIG_CDCACM_COMPOSITE</code>: - Configure the CDC serial driver as part of a composite driver - (only if <code>CONFIG_USBDEV_COMPOSITE</code> is also defined) - </li> - <li> - <code>CONFIG_CDCACM_IFNOBASE</code>: - If the CDC driver is part of a composite device, then this may need to - be defined to offset the CDC/ACM interface numbers so that they are - unique and contiguous. When used with the Mass Storage driver, the - correct value for this offset is zero. - </li> - <li> - <code>CONFIG_CDCACM_STRBASE</code>: - If the CDC driver is part of a composite device, then this may need to - be defined to offset the CDC/ACM string numbers so that they are - unique and contiguous. When used with the Mass Storage driver, the - correct value for this offset is four (this value actuallly only needs - to be defined if names are provided for the Notification interface, - <code>CONFIG_CDCACM_NOTIFSTR</code>, or the data interface, <code>CONFIG_CDCACM_DATAIFSTR</code>). - </li> - <li> - <code>CONFIG_CDCACM_EP0MAXPACKET</code>: Endpoint 0 max packet size. Default 64. - </li> - <li> - <code>CONFIG_CDCACM_EPINTIN</code>: The logical 7-bit address of a hardware endpoint that supports - interrupt IN operation. Default 2. - </li> - <li> - <code>CONFIG_CDCACM_EPINTIN_FSSIZE</code>: Max package size for the interrupt IN endpoint if full speed mode. Default 64. - </li> - <li> - <code>CONFIG_CDCACM_EPINTIN_HSSIZE</code>: Max package size for the interrupt IN endpoint if high speed mode. Default 64. - </li> - <li> - <code>CONFIG_CDCACM_EPBULKOUT</code>: The logical 7-bit address of a hardware endpoint that supports - bulk OUT operation. - </li> - <li> - <code>CONFIG_CDCACM_EPBULKOUT_FSSIZE</code>: Max package size for the bulk OUT endpoint if full speed mode. Default 64. - </li> - <li> - <code>CONFIG_CDCACM_EPBULKOUT_HSSIZE</code>: Max package size for the bulk OUT endpoint if high speed mode. Default 512. - </li> - <li> - <code>CONFIG_CDCACM_EPBULKIN</code>: The logical 7-bit address of a hardware endpoint that supports - bulk IN operation - </li> - <li> - <code>CONFIG_CDCACM_EPBULKIN_FSSIZE</code>: Max package size for the bulk IN endpoint if full speed mode. Default 64. - </li> - <li> - <code>CONFIG_CDCACM_EPBULKIN_HSSIZE</code>: Max package size for the bulk IN endpoint if high speed mode. Default 512. - </li> - <li> - <code>CONFIG_CDCACM_NWRREQS</code> and <code>CONFIG_CDCACM_NRDREQS</code>: The number of write/read requests that can be in flight. - <code>CONFIG_CDCACM_NWRREQS</code> includes write requests used for both the interrupt and bulk IN endpoints. - Default 4. - </li> - <li> - <code>CONFIG_CDCACM_VENDORID</code> and <code>CONFIG_CDCACM_VENDORSTR</code>: The vendor ID code/string. Default 0x0525 and "NuttX," - 0x0525 is the Netchip vendor and should not be used in any products. - This default VID was selected for compatibility with the Linux CDC ACM default VID. - </li> - <li> - <code>CONFIG_CDCACM_PRODUCTID</code> and <code>CONFIG_CDCACM_PRODUCTSTR</code>: The product ID code/string. Default 0xa4a7 and "CDC/ACM Serial" - 0xa4a7 was selected for compatibility with the Linux CDC ACM default PID. - </li> - <li> - <code>CONFIG_CDCACM_RXBUFSIZE</code> and <code>CONFIG_CDCACM_TXBUFSIZE</code>: Size of the serial receive/transmit buffers. Default 256. -</ul> - -<h3>USB Storage Device Configuration</h3> -<ul> - <li> - <code>CONFIG_USBMSC</code>: - Enable compilation of the USB storage driver - </li> - <li> - <code>CONFIG_USBMSC_COMPOSITE</code>: - Configure the mass storage driver as part of a composite driver - (only if <code>CONFIG_USBDEV_COMPOSITE</code> is also defined) - </li> - <li> - <code>CONFIG_USBMSC_IFNOBASE</code>: - If the CDC driver is part of a composite device, then this may need to - be defined to offset the mass storage interface number so that it is - unique and contiguous. When used with the CDC/ACM driver, the - correct value for this offset is two (because of the two CDC/ACM - interfaces that will precede it). - </li> - <li> - <code>CONFIG_USBMSC_STRBASE</code>: - If the CDC driver is part of a composite device, then this may need to - be defined to offset the mass storage string numbers so that they are - unique and contiguous. When used with the CDC/ACM driver, the - correct value for this offset is four (or perhaps 5 or 6, depending - on if <code>CONFIG_CDCACM_NOTIFSTR</code> or <code>CONFIG_CDCACM_DATAIFSTR</code> are defined). - </li> - <li> - <code>CONFIG_USBMSC_EP0MAXPACKET</code>: - Max packet size for endpoint 0 - </li> - <li> - <code>CONFIG_USBMSCEPBULKOUT</code> and <code>CONFIG_USBMSC_EPBULKIN</code>: - The logical 7-bit address of a hardware endpoints that support bulk OUT and IN operations - </li> - <li> - <code>CONFIG_USBMSC_NWRREQS</code> and <code>CONFIG_USBMSC_NRDREQS</code>: - The number of write/read requests that can be in flight - </li> - <li> - <code>CONFIG_USBMSC_BULKINREQLEN</code> and <code>CONFIG_USBMSC_BULKOUTREQLEN</code>: - The size of the buffer in each write/read request. - This value needs to be at least as large as the endpoint maxpacket and - ideally as large as a block device sector. - </li> - <li> - <code>CONFIG_USBMSC_VENDORID</code> and <code>CONFIG_USBMSC_VENDORSTR</code>: - The vendor ID code/string - </li> - <li> - <code>CONFIG_USBMSC_PRODUCTID</code> and <code>CONFIG_USBMSC_PRODUCTSTR</code>: - The product ID code/string - </li> - <li> - <code>CONFIG_USBMSC_REMOVABLE</code>: - Select if the media is removable - </li> -</ul> - -<h3>USB Composite Device Configuration</h3> -<ul> - <li> - <code>CONFIG_USBDEV_COMPOSITE</code>: - Enables USB composite device support - </li> - <li> - <code>CONFIG_CDCACM_COMPOSITE</code>: - Configure the CDC serial driver as part of a composite driver - (only if CONFIG_USBDEV_COMPOSITE is also defined) - </li> - <li> - <code>CONFIG_UBMSC_COMPOSITE</code>: - Configure the mass storage driver as part of a composite driver - (only if CONFIG_USBDEV_COMPOSITE is also defined) - </li> - <li> - <code>CONFIG_COMPOSITE_IAD</code>: - If one of the members of the composite has multiple interfaces - (such as CDC/ACM), then an Interface Association Descriptor (IAD) - will be necessary. Default: IAD will be used automatically if - needed. It should not be necessary to set this. - </li> - <li> - <code>CONFIG_COMPOSITE_EP0MAXPACKET</code>: - Max packet size for endpoint 0 - </li> - <li> - <code>CONFIG_COMPOSITE_VENDORID</code> and <code>CONFIG_COMPOSITE_VENDORSTR</code>: - The vendor ID code/string - </li> - <li> - <code>CONFIG_COMPOSITE_PRODUCTID</code> and <code>CONFIG_COMPOSITE_PRODUCTSTR</code>: - The product ID code/string - </li> - <li> - <code>CONFIG_COMPOSITE_SERIALSTR</code>: - Device serial number string - </li> - <li> - <code>CONFIG_COMPOSITE_CONFIGSTR</code>: - Configuration string - </li> - <li> - <code>CONFIG_COMPOSITE_VERSIONNO</code>: - Interface version number. - </li> -</ul> - -<h2>USB Host-Side Support</h2> -<h3>USB Host Controller Driver</h3> -<ul> - <li> - <code>CONFIG_USBHOST</code>: Enables USB host support - </li> - <li> - <code>CONFIG_USBHOST_NPREALLOC</code>: Number of pre-allocated class instances - </li> - <li> - <code>CONFIG_USBHOST_BULK_DISABLE</code>: On some architectures, selecting this setting will reduce driver size by disabling bulk endpoint support - </li> - <li> - <code>CONFIG_USBHOST_INT_DISABLE</code>: On some architectures, selecting this setting will reduce driver size by disabling interrupt endpoint support - </li> - <li> - <code>CONFIG_USBHOST_ISOC_DISABLE</code>: On some architectures, selecting this setting will reduce driver size by disabling isochronous endpoint support - </li> -</ul> -<h3>USB Host HID Class Driver</h3> + The latest boring configuration variable documentation can be regenerated at any time using that tool or, more appropriately, the wrapper script at <code>nuttx/tools/mkconfigvars.sh</code>. + That script will generate the file <code>nuttx/Documentation/NuttXConfigVariables.html</code>. <p> - Requires <code>CONFIG_USBHOST=y</code>, <code>CONFIG_USBHOST_INT_DISABLE=n</code>, <code>CONFIG_NFILE_DESCRIPTORS > 0</code>, - <code>CONFIG_SCHED_WORKQUEUE=y</code>, and <code>CONFIG_DISABLE_SIGNALS=n</code>. + The version of <code>NuttXConfigVariables.html</code> for the last released version of NuttX can also be found <a href="http://nuttx.org/Documentation/NuttXConfigVariables.html">online</a>. </p> -<ul> - <li> - <code>CONFIG_HIDKBD_POLLUSEC</code>: Device poll rate in microseconds. Default: 100 milliseconds. - </li> - <li> - <code>CONFIG_HIDKBD_DEFPRIO</code>: Priority of the polling thread. Default: 50. - </li> - <li> - <code>CONFIG_HIDKBD_STACKSIZE</code>: Stack size for polling thread. Default: 1024 - </li> - <li> - <code>CONFIG_HIDKBD_BUFSIZE</code>: Scancode buffer size. Default: 64. - </li> - <li> - <code>CONFIG_HIDKBD_NPOLLWAITERS</code>: If the poll() method is enabled, this defines the maximum number of threads that can be waiting for keyboard events. Default: 2. - </li> - <li> - <code>CONFIG_HIDKBD_RAWSCANCODES</code>: If set to <code>y</code> no conversion will be made on the raw keyboard scan codes. Default: ASCII conversion. - </li> - <li> - <code>CONFIG_HIDKBD_ALLSCANCODES</code>: If set to <code>y</code> all 231 possible scancodes will be converted to something. Default: 104 key US keyboard. - </li> - <li> - <code>CONFIG_HIDKBD_NODEBOUNCE</code>: If set to <code>y</code> normal debouncing is disabled. Default: Debounce/No repeat keys. - </li> -</ul> -<h3>USB Host HID Mass Storage Class Driver</h3> -<p> - Requires <code>CONFIG_USBHOST=y</code>, <code>CONFIG_USBHOST_BULK_DISABLE=n</code>, <code>CONFIG_NFILE_DESCRIPTORS > 0</code>, - and <code>CONFIG_SCHED_WORKQUEUE=y</code>. -</p> - -<h2>Graphics related configuration settings</h3> - <li> - <code>CONFIG_NX</code>: - Enables overall support for graphics library and NX - </li> -</ul> - -<h3>NX configuration setting</h3> -<ul> - <li> - <code>CONFIG_NX_MULTIUSER</code>: - Configures NX in multi-user mode. - </li> - <li> - <code>CONFIG_NX_NPLANES</code>: - Some YUV color formats requires support for multiple planes, - one for each color component. Unless you have such special - hardware, this value should be undefined or set to 1. - </li> - <li> - <code>CONFIG_NX_WRITEONLY</code>: - Define if the underlying graphics device does not support read operations. - Automatically defined if <code>CONFIG_NX_LCDDRIVER</code> and <code>CONFIG_LCD_NOGETRUN</code> - are defined. - </li> - <li> - <code>CONFIG_NX_DISABLE_1BPP</code>, <code>CONFIG_NX_DISABLE_2BPP</code>, - <code>CONFIG_NX_DISABLE_4BPP</code>, <code>CONFIG_NX_DISABLE_8BPP</code> - <code>CONFIG_NX_DISABLE_16BPP</code>, <code>CONFIG_NX_DISABLE_24BPP</code>, and - <code>CONFIG_NX_DISABLE_32BPP</code>: - NX supports a variety of pixel depths. You can save some - memory by disabling support for unused color depths. - </li> - <li> - <code>CONFIG_NX_PACKEDMSFIRST</code>: - If a pixel depth of less than 8-bits is used, then NX needs - to know if the pixels pack from the MS to LS or from LS to MS - </li> - <li> - <code>CONFIG_NX_LCDDRIVER</code>: - By default, NX builds to use a framebuffer driver (see <code>include/nuttx/video/fb.h</code>). - If this option is defined, NX will build to use an LCD driver (see <code>include/nuttx/lcd/lcd.h</code>). - </li> - <li> - <code>CONFIG_LCD_MAXPOWER</code>: - The full-on power setting for an LCD device. - </li> - <li> - <code>CONFIG_LCD_MAXCONTRAST</code>: - The maximum contrast value for an LCD device. - </li> - <li> - <code>CONFIG_LCD_LANDSCAPE</code>, <code>CONFIG_LCD_PORTRAIT</code>, - <code>CONFIG_LCD_RLANDSCAPE</code>, and <code>CONFIG_LCD_RPORTRAIT</code>: - Some LCD drivers may support these options to present the display in - landscape, portrait, reverse landscape, or reverse portrait orientations. - Check the <code>README.txt</code> file in each board configuration directory to - see if any of these are supported by the board LCD logic. - </li> - <li> - <code>CONFIG_LCD_NOGETRUN</code>: - NX components need to know if it can read from the LCD or not. - If reading from the LCD is supported, then NxConsole can do more efficient scrolling. - Default: Supported - </li> - <li> - <code>CONFIG_NX_MOUSE</code>: - Build in support for mouse input. - </li> - <li> - <code>CONFIG_NX_KBD</code>: - Build in support of keypad/keyboard input. - </li> - <li> - <code>CONFIG_NXTK_BORDERWIDTH</code>: - Specifies with with of the border (in pixels) used with - framed windows. The default is 4. - </li> - <li> - <code>CONFIG_NXTK_BORDERCOLOR1</code> and <code>CONFIG_NXTK_BORDERCOLOR2</code>: - Specify the colors of the border used with framed windows. - <code>CONFIG_NXTK_BORDERCOLOR2</code> is the shadow side color and so - is normally darker. The default is medium and dark grey, - respectively - </li> - <li> - <code>CONFIG_NXTK_AUTORAISE</code>: - If set, a window will be raised to the top if the mouse position - is over a visible portion of the window. Default: A mouse - button must be clicked over a visible portion of the window. - </li> - <li> - <code>CONFIG_NXFONTS_CHARBITS</code>: - The number of bits in the character set. Current options are - only 7 and 8. The default is 7. - </li> - <li> - <code>CONFIG_NXFONT_SANS17X22</code>: - This option enables support for a tiny, 17x22 san serif font - (font <code>ID FONTID_SANS17X22</code> == 14). - </li> - <li> - <code>CONFIG_NXFONT_SANS20X26</code>: - This option enables support for a tiny, 20x26 san serif font - (font <code>ID FONTID_SANS20X26</code> == 15). - </li> - <li> - <code>CONFIG_NXFONT_SANS23X27</code>: - This option enables support for a tiny, 23x27 san serif font - (font <code>ID FONTID_SANS23X27</code> == 1). - </li> - <li> - <code>CONFIG_NXFONT_SANS22X29</code>: - This option enables support for a small, 22x29 san serif font - (font <code>ID FONTID_SANS22X29</code> == 2). - </li> - <li> - <code>CONFIG_NXFONT_SANS28X37</code>: - This option enables support for a medium, 28x37 san serif font - (font <code>ID FONTID_SANS28X37</code> == 3). - </li> - <li> - <code>CONFIG_NXFONT_SANS39X48</code>: - This option enables support for a large, 39x48 san serif font - (font <code>ID FONTID_SANS39X48</code> == 4). - </li> - <li> - <code>CONFIG_NXFONT_SANS17X23B</code>: - This option enables support for a tiny, 17x23 san serif bold font - (font <code>ID FONTID_SANS17X23B</code> == 16). - </li> - <li> - <code>CONFIG_NXFONT_SANS20X27B</code>: - This option enables support for a tiny, 20x27 san serif bold font - (font <code>ID FONTID_SANS20X27B</code> == 17). - </li> - <li> - <code>CONFIG_NXFONT_SANS22X29B</code>: - This option enables support for a small, 22x29 san serif bold font - (font ID <code>FONTID_SANS22X29B</code> == 5). - </li> - <li> - <code>CONFIG_NXFONT_SANS28X37B</code>: - This option enables support for a medium, 28x37 san serif bold font - (font ID <code>FONTID_SANS28X37B</code> == 6). - </li> - <li> - <code>CONFIG_NXFONT_SANS40X49B</code>: - This option enables support for a large, 40x49 san serif bold font - (font ID <code>FONTID_SANS40X49B</code> == 7). - </li> - <li> - <code>CONFIG_NXFONT_SERIF22X29</code>: - This option enables support for a small, 22x29 font (with serifs) - (font ID <code>FONTID_SERIF22X29</code> == 8). - </li> - <li> - <code>CONFIG_NXFONT_SERIF29X37</code>: - This option enables support for a medium, 29x37 font (with serifs) - (font ID <code>FONTID_SERIF29X37</code> == 9). - </li> - <li> - <code>CONFIG_NXFONT_SERIF38X48</code>: - This option enables support for a large, 38x48 font (with serifs) - (font ID <code>FONTID_SERIF38X48</code> == 10). - </li> - <li> - <code>CONFIG_NXFONT_SERIF22X28B</code>: - This option enables support for a small, 27x38 bold font (with serifs) - (font ID <code>FONTID_SERIF22X28B</code> == 11). - </li> - <li> - <code>CONFIG_NXFONT_SERIF27X38B</code>: - This option enables support for a medium, 27x38 bold font (with serifs) - (font ID <code>FONTID_SERIF27X38B</code> == 12). - </li> - <li> - <code>CONFIG_NXFONT_SERIF38X49B</code>: - This option enables support for a large, 38x49 bold font (with serifs) - (font ID <code>FONTID_SERIF38X49B</code> == 13). - </li> -</ul> - -<h3>NX Multi-user only options</h3> -<ul> - <li> - <code>CONFIG_NX_BLOCKING</code> - Open the client message queues in blocking mode. In this case, - <code>nx_eventhandler()</code> will not return until a message is received and processed. - </li> - <li> - <code>CONFIG_NX_MXSERVERMSGS</code> and <code>CONFIG_NX_MXCLIENTMSGS</code> - Specifies the maximum number of messages that can fit in - the message queues. No additional resources are allocated, but - this can be set to prevent flooding of the client or server with - too many messages (<code>CONFIG_PREALLOC_MQ_MSGS</code> controls how many - messages are pre-allocated). - </li> -</ul> - -<h2>Stack and heap information</h2> - -<ul> - <li> - <code>CONFIG_BOOT_RUNFROMFLASH</code>: Some configurations support XIP - operation from FLASH but must copy initialized .data sections to RAM. - </li> - <li> - <code>CONFIG_BOOT_COPYTORAM</code>: Some configurations boot in FLASH - but copy themselves entirely into RAM for better performance. - </li> - <li> - <code>CONFIG_BOOT_RAMFUNCS</code>: Other configurations may copy just - some functions into RAM, either for better performance or for errata workarounds. - </li> - <li> - <code>CONFIG_STACK_ALIGNMENT</code>: Set if the your application has specific - stack alignment requirements (may not be supported in all architectures). - </li> - <li> - <code>CONFIG_IDLETHREAD_STACKSIZE</code>: The size of the initial stack. - This is the thread that (1) performs the initial boot of the system up - to the point where <code>CONFIG_USER_ENTRYPOINT</code>() is spawned, - and (2) there after is the IDLE thread that executes only when there - is no other thread ready to run. - </li> - <li> - <code>CONFIG_USERMAIN_STACKSIZE</code>: The size of the stack to allocate - for the main user thread that begins at the <code>CONFIG_USER_ENTRYPOINT</code>() - entry point. - </li> - <li> - <code>CONFIG_PTHREAD_STACK_MIN</code>: Minimum pthread stack size - </li> - <li> - <code>CONFIG_PTHREAD_STACK_DEFAULT</code>: Default pthread stack size - </li> -</ul> <table width ="100%"> <tr bgcolor="#e4e4e4"> diff --git a/nuttx/configs/README.txt b/nuttx/configs/README.txt index 559bfcd66..2810d908d 100644 --- a/nuttx/configs/README.txt +++ b/nuttx/configs/README.txt @@ -6,7 +6,7 @@ Table of Contents o Board-Specific Configurations o Summary of Files o Configuration Variables - o Supported Architectures + o Supported Boards o Configuring NuttX o Building Symbol Tables @@ -145,1554 +145,26 @@ setenv.sh -- This is a script that you can include that will be installed at Configuration Variables ^^^^^^^^^^^^^^^^^^^^^^^ -Note. This section 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. - -The following variables are recognized by the build (you may also include -architecture/board-specific settings). - - Architecture selection: - - CONFIG_ARCH - Identifies the arch/ subdirectory - CONFIG_ARCH_name - For use in C code - CONFIG_ARCH_CHIP - Identifies the arch/*/chip subdirectory - CONFIG_ARCH_CHIP_name - For use in C code - CONFIG_ARCH_BOARD - Identifies the configs subdirectory and - hence, the board that supports the particular chip or SoC. - CONFIG_ARCH_BOARD_name - For use in C code - CONFIG_ENDIAN_BIG - define if big endian (default is little - endian) - CONFIG_ARCH_NOINTC - define if the architecture does not - support an interrupt controller or otherwise cannot support - APIs like up_enable_irq() and up_disable_irq(). - CONFIG_ARCH_VECNOTIRQ - Usually the interrupt vector number provided - to interfaces like irq_attach() and irq_detach are the same as IRQ - numbers that are provied to IRQ management functions like - up_enable_irq() and up_disable_irq(). But that is not true for all - interrupt controller implementations. For example, the PIC32MX - interrupt controller manages interrupt sources that have a many-to-one - relationship to interrupt vectors. In such cases, CONFIG_ARCH_VECNOTIRQ - must defined so that the OS logic will know not to assume it can use - a vector number to enable or disable interrupts. - CONFIG_ARCH_IRQPRIO - Define if the architecture suports prioritizaton of interrupts - and the up_prioritize_irq() API. - CONFIG_ADDRENV - The CPU supports an MMU and CPU port supports provision of address - environments for tasks (making the, perhaps, processes). - - Some architectures require a description of the RAM configuration: - - CONFIG_RAM_SIZE - Describes the installed DRAM. - CONFIG_RAM_START - The start address of DRAM (physical) - CONFIG_RAM_VSTART - The start address of DRAM (virtual) - - General build options: - - CONFIG_RRLOAD_BINARY - make the rrload binary format used with - BSPs from www.ridgerun.com using the tools/mkimage.sh script. - CONFIG_INTELHEX_BINARY - make the Intel HEX binary format - used with many different loaders using the GNU objcopy program - Should not be selected if you are not using the GNU toolchain. - CONFIG_MOTOROLA_SREC - make the Motorola S-Record binary format - used with many different loaders using the GNU objcopy program - Should not be selected if you are not using the GNU toolchain. - CONFIG_RAW_BINARY - make a raw binary format file used with many - different loaders using the GNU objcopy program. This option - should not be selected if you are not using the GNU toolchain. - CONFIG_HAVE_CXX - toolchain supports C++ and CXX, CXXFLAGS, and - COMPILEXX have been defined in the configurations Make.defs - file. - CONFIG_HAVE_CXXINITIALIZE - The platform-specific logic includes support - for initialization of static C++ instances for this architecture - and for the selected toolchain (via up_cxxinitialize()). - - Building application code: - - CONFIG_APPS_DIR - Identifies the directory that builds the - application to link with NuttX. Default: ../apps This symbol must be assigned - to the path to the application build directory *relative* to - the NuttX top build direcory. If you had an application - directory and the NuttX directory each in separate directory - trees like this: - - build - |-nuttx - | | - | `- Makefile - `-application - | - `- Makefile - - Then you would set CONFIG_APPS_DIR=../application. - - The application direction must contain Makefile and this make - file must support the following targets: - - - libapps$(LIBEXT) (usually libapps.a). libapps.a is a static - library ( an archive) that contains all of application object - files. - - clean. Do whatever is appropriate to clean the application - directories for a fresh build. - - distclean. Clean everthing -- auto-generated files, symbolic - links etc. -- so that the directory contents are the same as - the contents in your configuration management system. - This is only done when you change the NuttX configuration. - - depend. Make or update the application build dependencies. - - When this application is invoked it will receive the setting TOPDIR like: - - $(MAKE) -C $(CONFIG_APPS_DIR) TOPDIR="$(TOPDIR)" <target> - - TOPDIR is the full path to the NuttX directory. It can be used, for - example, to include makefile fragments (e.g., .config or Make.defs) - or to set up include file paths. - - 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). If the pass1 obect is an archive, it could - go anywhere. - - CONFIG_BUILD_2PASS - Enables the two pass build options. - - When the two pass build option is enabled, the following also apply: - - CONFIG_PASS1_TARGET - The name of the first pass build target. This - can be specific build target, a special build target (all, default, etc.) - or may just be left undefined. - CONFIG_PASS1_BUILDIR - The path, relative to the top NuttX build - directory to directory that contains the Makefile to build the - first pass object. The Makefile must support the following targets: - - The special target CONFIG_PASS1_TARGET (if defined) - - and the usual depend, clean, and distclean targets. - CONFIG_PASS1_OBJECT - May be used to include an extra, pass1 object - into the final link. This would probably be the object generated - from the CONFIG_PASS1_TARGET. It may be available at link time - in the arch/<architecture>/src directory. - - General OS setup - - CONFIG_DEBUG - enables built-in debug options - CONFIG_DEBUG_VERBOSE - enables verbose debug output - CCONFIG_SYSLOG_ENABLE - Support an interface to enable or disable debug output. - CONFIG_DEBUG_SYMBOLS - build without optimization and with - debug symbols (needed for use with a debugger). - CONFIG_DEBUG_SCHED - enable OS debug output (disabled by - default) - CONFIG_DEBUG_MM - enable memory management debug output - (disabled by default) - CONFIG_DEBUG_NET - enable network debug output (disabled - by default) - CONFIG_DEBUG_USB - enable usb debug output (disabled by - default) - CONFIG_DEBUG_FS - enable filesystem debug output (disabled - by default) - CONFIG_DEBUG_LIB - enable C library debug output (disabled - by default) - CONFIG_DEBUG_BINFMT - enable binary loader debug output (disabled - by default) - CONFIG_DEBUG_GRAPHICS - enable NX graphics debug output - (disabled by default) - - CONFIG_MM_REGIONS - If the architecture includes multiple - regions of memory to allocate from, this specifies the - number of memory regions that the memory manager must - handle and enables the API mm_addregion(heap, start, end); - CONFIG_MM_SMALL - Each memory allocation has a small allocation - overhead. The size of that overhead is normally determined by - the "width" of the address support by the MCU. MCUs that support - 16-bit addressability have smaller overhead than devices that - support 32-bit addressability. However, there are many MCUs - that support 32-bit addressability *but* have internal SRAM - of size less than or equal to 64Kb. In this case, CONFIG_MM_SMALL - can be defined so that those MCUs will also benefit from the - smaller, 16-bit-based allocation overhead. - CONFIG_HEAP2_BASE and CONFIG_HEAP2_SIZE - Some architectures use these settings to specify the size of - a second heap region. - CONFIG_GRAN - Enable granual allocator support. Allocations will be aligned to the - granule size; allocations will be in units of the granule size. - Larger granules will give better performance and less overhead but - more losses of memory due to alignment and quantization waste. - NOTE: The current implementation also restricts the maximum - allocation size to 32 granaules. That restriction could be - eliminated with some additional coding effort. - CONFIG_GRAN_SINGLE - Select if there is only one instance of the granule allocator (i.e., - gran_initialize will be called only once. In this case, (1) there - are a few optimizations that can can be done and (2) the GRAN_HANDLE - is not needed. - CONFIG_GRAN_INTR - Normally mutual exclusive access to granule allocator - data is assured using a semaphore. If this option is set then, instead, - mutual exclusion logic will disable interrupts. While this options is - more invasive to system performance, it will also support use of the - granule allocator from interrupt level logic. - CONFIG_DEBUG_GRAM - Just like CONFIG_DEBUG_MM, but only generates ouput from the gran - allocation logic. - - CONFIG_ARCH_LOWPUTC - architecture supports low-level, boot - time console output - CONFIG_MSEC_PER_TICK - The default system timer is 100Hz - or MSEC_PER_TICK=10. This setting may be defined to - inform NuttX that the processor hardware is providing - system timer interrupts at some interrupt interval other - than 10 msec. - CONFIG_RR_INTERVAL - The round robin timeslice will be set - this number of milliseconds; Round robin scheduling can - be disabled by setting this value to zero. - CONFIG_SCHED_INSTRUMENTATION - enables instrumentation in - scheduler to monitor system performance - CONFIG_TASK_NAME_SIZE - Specifies that maximum size of a - task name to save in the TCB. Useful if scheduler - instrumentation is selected. Set to zero to disable. - CONFIG_SCHED_HAVE_PARENT - Remember the ID of the parent task - when a new child task is created. This support enables some - additional features (such as SIGCHLD) and modifies the behavior - of other interfaces. For example, it makes waitpid() more - standards complete by restricting the waited-for tasks to the - children of the caller. Default: disabled. - CONFIG_SCHED_CHILD_STATUS - If this option is selected, then the exit status of the child task - will be retained after the child task exits. This option should be - selected if you require knowledge of a child process' exit status. - Without this setting, wait(), waitpid() or waitid() may fail. For - example, if you do: - - 1) Start child task - 2) Wait for exit status (using wait(), waitpid(), or waitid()). - - This can fail because the child task may run to completion before - the wait begins. There is a non-standard work-around in this case: - The above sequence will work if you disable pre-emption using - sched_lock() prior to starting the child task, then re-enable pre- - emption with sched_unlock() after the wait completes. This works - because the child task is not permitted to run until the wait is in - place. - - The standard solution would be to enable CONFIG_SCHED_CHILD_STATUS. In - this case the exit status of the child task is retained after the - child exits and the wait will successful obtain the child task's - exit status whether it is called before the child task exits or not. - - Warning: If you enable this feature, then your application must - either (1) take responsibility for reaping the child status with wait(), - waitpid(), or waitid(), or (2) suppress retention of child status. - If you do not reap the child status, then you have a memory leak and - your system will eventually fail. - - Retention of child status can be suppressed on the parent using logic like: - - struct sigaction sa; - - sa.sa_handler = SIG_IGN; - sa.sa_flags = SA_NOCLDWAIT; - int ret = sigaction(SIGCHLD, &sa, NULL); - - CONFIG_PREALLOC_CHILDSTATUS - To prevent runaway child status allocations and to improve - allocation performance, child task exit status structures are pre- - allocated when the system boots. This setting determines the number - of child status structures that will be pre-allocated. If this - setting is not defined or if it is defined to be zero then a value - of 2*MAX_TASKS is used. - - Note that there cannot be more that CONFIG_MAX_TASKS tasks in total. - However, the number of child status structures may need to be - significantly larger because this number includes the maximum number - of tasks that are running PLUS the number of tasks that have exit'ed - without having their exit status reaped (via wait(), waitid(), or - waitpid()). - - Obviously, if tasks spawn children indefinitely and never have the - exit status reaped, then you may have a memory leak! If you enable - the SCHED_CHILD_STATUS feature, then your application must take - responsibility for either (1) reaping the child status with wait(), - waitpid(), or waitid() or it must (2) suppress retention of child - status. Otherwise, your system will eventually fail. - - Retention of child status can be suppressed on the parent using logic like: - - struct sigaction sa; - - sa.sa_handler = SIG_IGN; - sa.sa_flags = SA_NOCLDWAIT; - int ret = sigaction(SIGCHLD, &sa, NULL); - - CONFIG_START_YEAR, CONFIG_START_MONTH, CONFIG_START_DAY - - Used to initialize the internal time logic. - CONFIG_GREGORIAN_TIME - Enables Gregorian time conversions. - You would only need this if you are concerned about accurate - time conversions in the past or in the distant future. - CONFIG_JULIAN_TIME - Enables Julian time conversions. You - would only need this if you are concerned about accurate - time conversion in the distand past. You must also define - CONFIG_GREGORIAN_TIME in order to use Julian time. - CONFIG_DEV_CONSOLE - Set if architecture-specific logic - provides /dev/console. Enables stdout, stderr, stdin. - This implies the "normal" serial driver provides the - console unless another console device is specified - (See CONFIG_DEV_LOWCONSOLE). - CONFIG_MUTEX_TYPES - Set to enable support for recursive and - errorcheck mutexes. Enables pthread_mutexattr_settype(). - CONFIG_PRIORITY_INHERITANCE - Set to enable support for - priority inheritance on mutexes and semaphores. - Priority inheritance is a strategy for addressing priority - inversion. - CONFIG_SEM_PREALLOCHOLDERS: This setting is only used if priority - inheritance is enabled. It defines the maximum number of - different threads (minus one) that can take counts on a - semaphore with priority inheritance support. This may be - set to zero if priority inheritance is disabled OR if you - are only using semaphores as mutexes (only one holder) OR - if no more than two threads participate using a counting - semaphore. If defined, then this should be a relatively - large number because this is the total number of counts on - the total number of semaphores (like 64 or 100). - CONFIG_SEM_NNESTPRIO. If priority inheritance is enabled, - then this setting is the maximum number of higher priority - threads (minus 1) than can be waiting for another thread - to release a count on a semaphore. This value may be set - to zero if no more than one thread is expected to wait for - a semaphore. If defined, then this should be a relatively - small number because this the number of maximumum of waiters - on one semaphore (like 4 or 8). - CONFIG_FDCLONE_DISABLE. Disable cloning of all file descriptors - by task_create() when a new task is started. If set, all - files/drivers will appear to be closed in the new task. - CONFIG_FDCLONE_STDIO. Disable cloning of all but the first - three file descriptors (stdin, stdout, stderr) by task_create() - when a new task is started. If set, all files/drivers will - appear to be closed in the new task except for stdin, stdout, - and stderr. - CONFIG_SDCLONE_DISABLE. Disable cloning of all socket - desciptors by task_create() when a new task is started. If - set, all sockets will appear to be closed in the new task. - CONFIG_SCHED_WORKQUEUE. Create a dedicated "worker" thread to - handle delayed processing from interrupt handlers. This feature - is required for some drivers but, if there are not complaints, - can be safely disabled. The worker thread also performs - garbage collection -- completing any delayed memory deallocations - from interrupt handlers. If the worker thread is disabled, - then that clean will be performed by the IDLE thread instead - (which runs at the lowest of priority and may not be appropriate - if memory reclamation is of high priority). If CONFIG_SCHED_WORKQUEUE - is enabled, then the following options can also be used: - CONFIG_SCHED_WORKPRIORITY - The execution priority of the worker - thread. Default: 192 - CONFIG_SCHED_WORKPERIOD - How often the worker thread checks for - work in units of microseconds. Default: 50*1000 (50 MS). - CONFIG_SCHED_WORKSTACKSIZE - The stack size allocated for the worker - thread. Default: CONFIG_IDLETHREAD_STACKSIZE. - CONFIG_SIG_SIGWORK - The signal number that will be used to wake-up - the worker thread. Default: 17 - CONFIG_SCHED_LPWORK. If CONFIG_SCHED_WORKQUEUE is defined, then a single - work queue is created by default. If CONFIG_SCHED_LPWORK is also defined - then an additional, lower-priority work queue will also be created. This - lower priority work queue is better suited for more extended processing - (such as file system clean-up operations) - CONFIG_SCHED_LPWORKPRIORITY - The execution priority of the lower priority - worker thread. Default: 50 - CONFIG_SCHED_LPWORKPERIOD - How often the lower priority worker thread - checks for work in units of microseconds. Default: 50*1000 (50 MS). - CONFIG_SCHED_LPWORKSTACKSIZE - The stack size allocated for the lower - priority worker thread. Default: CONFIG_IDLETHREAD_STACKSIZE. - CONFIG_SCHED_WAITPID - Enables the waitpid() interface in a default, - non-standard mode (non-standard in the sense that the waited for - PID need not be child of the caller). If SCHED_HAVE_PARENT is - also defined, then this setting will modify the behavior or - waitpid() (making more spec compliant) and will enable the - waitid() and wait() interfaces as well. - CONFIG_SCHED_ATEXIT - Enables the atexit() API - CONFIG_SCHED_ATEXIT_MAX - By default if CONFIG_SCHED_ATEXIT is - selected, only a single atexit() function is supported. That number - can be increased by defined this setting to the number that you require. - CONFIG_SCHED_ONEXIT - Enables the on_exit() API - CONFIG_SCHED_ONEXIT_MAX - By default if CONFIG_SCHED_ONEXIT is selected, - only a single on_exit() function is supported. That number can be - increased by defined this setting to the number that you require. - CONFIG_USER_ENTRYPOINT - The name of the entry point for user - applications. For the example applications this is of the form 'app_main' - where 'app' is the application name. If not defined, CONFIG_USER_ENTRYPOINT - defaults to user_start. - - Signal Numbers: - - CONFIG_SIG_SIGUSR1 - Value of standard user signal 1 (SIGUSR1). - Default: 1 - CONFIG_SIG_SIGUSR2 - Value of standard user signal 2 (SIGUSR2). - Default: 2 - CONFIG_SIG_SIGALARM - Default the standard signal used with POSIX - timers (SIGALRM). Default: 3 - CONFIG_SIG_SIGCHLD - The SIGCHLD signal is sent to the parent of a child - process when it exits, is interrupted (stopped), or resumes after being - interrupted. Default: 4 - - CONFIG_SIG_SIGCONDTIMEDOUT - This non-standard signal number is used in - the implementation of pthread_cond_timedwait(). Default 16. - CONFIG_SIG_SIGWORK - SIGWORK is a non-standard signal used to wake up - the internal NuttX worker thread. Default: 17. - - Binary Loaders: - CONFIG_BINFMT_DISABLE - By default, support for loadable binary formats - is built. - This logic may be suppressed be defining this setting. - CONFIG_BINFMT_CONSTRUCTORS - Build in support for C++ constructors in - loaded modules. - CONFIG_SYMTAB_ORDEREDBYNAME - Symbol tables are order by name (rather - than value). - CONFIG_NXFLAT. Enable support for the NXFLAT binary format. This format - will support execution of NuttX binaries located in a ROMFS filesystem - (see apps/examples/nxflat). - CONFIG_ELF - Enable support for the ELF binary format. This format will - support execution of ELF binaries copied from a file system and - relocated into RAM (see apps/examples/elf). - - If CONFIG_ELF is selected, then these additional options are available: - - CONFIG_ELF_ALIGN_LOG2 - Align all sections to this Log2 value: 0->1, - 1->2, 2->4, etc. - CONFIG_ELF_STACKSIZE - This is the default stack size that will will - be used when starting ELF binaries. - CONFIG_ELF_BUFFERSIZE - This is an I/O buffer that is used to access - the ELF file. Variable length items will need to be read (such as - symbol names). This is really just this initial size of the buffer; - it will be reallocated as necessary to hold large symbol names). - Default: 128 - CONFIG_ELF_BUFFERINCR - This is an I/O buffer that is used to access - the ELF file. Variable length items will need to be read (such as - symbol names). This value specifies the size increment to use each - time the buffer is reallocated. Default: 32 - CONFIG_ELF_DUMPBUFFER - Dump various ELF buffers for debug purposes. - This option requires CONFIG_DEBUG and CONFIG_DEBUG_VERBOSE. - - System Logging: - CONFIG_SYSLOG enables general system logging support. - CONFIG_SYSLOG_DEVPATH - The full path to the system logging device. Default - "/dev/ramlog" (RAMLOG) or "dev/ttyS1" (character device) - - At present, there are two system loggins devices available. If CONFIG_SYSLOG - is selected, then these options are also available. - - CONFIG_SYSLOG_CHAR - Enable the generic character device for the SYSLOG. - A disadvantage of using the generic character device for the SYSLOG is that - it cannot handle debug output generated from interrupt level handlers. - NOTE: No more than one SYSLOG device should be configured. - - CONFIG_RAMLOG - Enables the RAM logging feature. The RAM log is a circular - buffer in RAM. NOTE: No more than one SYSLOG device should be configured. - CONFIG_RAMLOG_CONSOLE - Use the RAM logging device as a system console. - If this feature is enabled (along with CONFIG_DEV_CONSOLE), then all - console output will be re-directed to a circular buffer in RAM. This - is useful, for example, if the only console is a Telnet console. Then - in that case, console output from non-Telnet threads will go to the - circular buffer and can be viewed using the NSH 'dmesg' command. - CONFIG_RAMLOG_SYSLOG - Use the RAM logging device for the syslogging - interface. If this feature is enabled (along with CONFIG_SYSLOG), - then all debug output (only) will be re-directed to the circular - buffer in RAM. This RAM log can be view from NSH using the 'dmesg' - command. NOTE: Unlike the limited, generic character driver SYSLOG - device, the RAMLOG *can* be used to generate debug output from interrupt - level handlers. - CONFIG_RAMLOG_NPOLLWAITERS - The number of threads than can be waiting - for this driver on poll(). Default: 4 - - If CONFIG_RAMLOG_CONSOLE or CONFIG_RAMLOG_SYSLOG is selected, then the - following may also be provided: - - CONFIG_RAMLOG_CONSOLE_BUFSIZE - Size of the console RAM log. Default: 1024 - - Kernel build options: - CONFIG_NUTTX_KERNEL - Builds NuttX as a separately compiled kernel. - CONFIG_SYS_RESERVED - Reserved system call values for use - by architecture-specific logic. - - OS setup related to on-demand paging: - - CONFIG_PAGING - If set =y in your configation file, this setting will - enable the on-demand paging feature as described in - http://www.nuttx.org/NuttXDemandPaging.html. - - 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: - - CONFIG_PAGING_PAGESIZE - The size of one managed page. This must - be a value supported by the processor's memory management unit. - CONFIG_PAGING_NLOCKED - This is the number of locked pages in the - memory map. The locked address region will then be from - CONFIG_RAM_VSTART through (CONFIG_RAM_VSTART + - CONFIG_PAGING_PAGESIZE*CONFIG_PAGING_NLOCKED) - CONFIG_PAGING_LOCKED_PBASE and CONFIG_PAGING_LOCKED_VBASE - These - may be defined to determine the base address of the locked page - regions. If neither are defined, the logic will be set the bases - to CONFIG_RAM_START and CONFIG_RAM_VSTART (i.e., it assumes - that the base address of the locked region is at the beginning - of RAM). - NOTE: In some architectures, it may be necessary to take some - memory from the beginning of this region for vectors or for a - page table. In such cases, CONFIG_PAGING_LOCKED_P/VBASE should - take that into consideration to prevent overlapping the locked - memory region and the system data at the beginning of SRAM. - CONFIG_PAGING_NPPAGED - This is the number of physical pages - available to support the paged text region. This paged region - begins at (CONFIG_PAGING_LOCKED_PBASE + CONFIG_PAGING_PAGESIZE*CONFIG_PAGING_NPPAGED) - and continues until (CONFIG_PAGING_LOCKED_PBASE + CONFIG_PAGING_PAGESIZE*(CONFIG_PAGING_NLOCKED + - CONFIG_PAGING_NPPAGED) - CONFIG_PAGING_NVPAGED - This actual size of the paged text region - (in pages). This is also the number of virtual pages required to - support the entire paged region. The on-demand paging feature is - intended to support only the case where the virtual paged text - area is much larger the available physical pages. Otherwise, why - would you enable on-demand paging? - CONFIG_PAGING_NDATA - This is the number of data pages in the memory - map. The data region will extend to the end of RAM unless overridden - by a setting in the configuration file. - NOTE: In some architectures, it may be necessary to take some memory - from the end of RAM for page tables or other system usage. The - configuration settings and linker directives must be cognizant of that: - CONFIG_PAGING_NDATA should be defined to prevent the data region from - extending all the way to the end of memory. - CONFIG_PAGING_DEFPRIO - The default, minimum priority of the page fill - worker thread. The priority of the page fill work thread will be boosted - boosted dynmically so that it matches the priority of the task on behalf - of which it peforms the fill. This defines the minimum priority that - will be used. Default: 50. - CONFIG_PAGING_STACKSIZE - Defines the size of the allocated stack - for the page fill worker thread. Default: 1024. - CONFIG_PAGING_BLOCKINGFILL - The architecture specific up_fillpage() - function may be blocking or non-blocking. If defined, this setting - indicates that the up_fillpage() implementation will block until the - transfer is completed. Default: Undefined (non-blocking). - CONFIG_PAGING_WORKPERIOD - The page fill worker thread will wake periodically - even if there is no mapping to do. This selection controls that wake-up - period (in microseconds). This wake-up a failsafe that will handle any - cases where a single is lost (that would really be a bug and shouldn't - happen!) and also supports timeouts for case of non-blocking, asynchronous - fills (see CONFIG_PAGING_TIMEOUT_TICKS). - CONFIG_PAGING_TIMEOUT_TICKS - If defined, the implementation will monitor - the (asynchronous) page fill logic. If the fill takes longer than this - number if microseconds, then a fatal error will be declared. - Default: No timeouts monitored. - - Some architecture-specific settings. Defaults are architecture specific. - If you don't know what you are doing, it is best to leave these undefined - and try the system defaults: - - CONFIG_PAGING_VECPPAGE - This the physical address of the page in - memory to be mapped to the vector address. - CONFIG_PAGING_VECL2PADDR - This is the physical address of the L2 - page table entry to use for the vector mapping. - CONFIG_PAGING_VECL2VADDR - This is the virtual address of the L2 - page table entry to use for the vector mapping. - CONFIG_PAGING_BINPATH - If CONFIG_PAGING_BINPATH is defined, then it - is the full path to a file on a mounted file system that contains - a binary image of the NuttX executable. Pages will be filled by - reading from offsets into this file that correspond to virtual - fault addresses. - CONFIG_PAGING_MOUNTPT - If CONFIG_PAGING_BINPATH is defined, additional - options may be provided to control the initialization of underlying - devices. CONFIG_PAGING_MOUNTPT identifies the mountpoint to be used - if a device is mounted. - CONFIG_PAGING_MINOR - Some mount operations require a "minor" number - to identify the specific device instance. Default: 0 - CONFIG_PAGING_SDSLOT - If CONFIG_PAGING_BINPATH is defined, additional - options may be provided to control the initialization of underlying - devices. CONFIG_PAGING_SDSLOT identifies the slot number of the SD - device to initialize. This must be undefined if SD is not being used. - This should be defined to be zero for the typical device that has - only a single slot (See CONFIG_MMCSD_NSLOTS). If defined, - CONFIG_PAGING_SDSLOT will instruct certain board-specific logic to - initialize the media in this SD slot. - CONFIG_PAGING_M25PX - Use the m25px.c FLASH driver. If this is selected, - then the MTD interface to the M25Px device will be used to support - paging. - CONFIG_PAGING_AT45DB - Use the at45db.c FLASH driver. If this is selected, - then the MTD interface to the Atmel AT45DB device will be used to support - paging. - CONFIG_PAGING_BINOFFSET - If CONFIG_PAGING_M25PX or is CONFIG_PAGING_AT45DB - defined then CONFIG_PAGING_BINOFFSET will be used to specify the offset - in bytes into the FLASH device where the NuttX binary image is located. - Default: 0 - CONFIG_PAGING_SPIPORT - If CONFIG_PAGING_M25PX CONFIG_PAGING_AT45DB is - defined and the device has multiple SPI busses (ports), then this - configuration should be set to indicate which SPI port the device is - connected. Default: 0 - - 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. - - There are certain dependency relationships in these features. - - o mq_notify logic depends on signals to awaken tasks - waiting for queues to become full or empty. - o pthread_condtimedwait() depends on signals to wake - up waiting tasks. - - CONFIG_DISABLE_CLOCK, CONFIG_DISABLE_POSIX_TIMERS, CONFIG_DISABLE_PTHREAD. - CONFIG_DISABLE_SIGNALS, CONFIG_DISABLE_MQUEUE, CONFIG_DISABLE_MOUNTPOUNT, - CONFIG_DISABLE_ENVIRON, CONFIG_DISABLE_POLL - - Misc libc settings - - CONFIG_NOPRINTF_FIELDWIDTH - sprintf-related logic is a little smaller - if we do not support fieldwidthes - CONFIG_LIBC_FLOATINGPOINT - By default, floating point support in printf, - sscanf, etc. is disabled. - CONFIG_LIBC_STRERROR - strerror() is useful because it decodes 'errno' - values into a human readable strings. But it can also require - a lot of memory. If this option is selected, strerror() will still - exist in the build but it will not decode error values. This option - should be used by other logic to decide if it should use strerror() or - not. For example, the NSH application will not use strerror() if this - option is not selected; perror() will not use strerror() is this option - is not selected (see also CONFIG_NSH_STRERROR). - CONFIG_LIBC_STRERROR_SHORT - If this option is selected, then strerror() - will use a shortened string when it decodes the error. Specifically, - strerror() is simply use the string that is the common name for the - error. For example, the 'errno' value of 2 will produce the string - "No such file or directory" if CONFIG_LIBC_STRERROR_SHORT is not - defined but the string "ENOENT" if CONFIG_LIBC_STRERROR_SHORT is - defined. - CONFIG_LIBC_PERROR_STDOUT - POSIX requires that perror() provide its output - on stderr. This option may be defined, however, to provide perror() output - that is serialized with other stdout messages. - - Allow for architecture optimized implementations - - The architecture can provide optimized versions of the - following to improve system performance - - CONFIG_ARCH_MEMCPY, CONFIG_ARCH_MEMCMP, CONFIG_ARCH_MEMMOVE - CONFIG_ARCH_MEMSET, CONFIG_ARCH_STRCMP, CONFIG_ARCH_STRCPY - CONFIG_ARCH_STRNCPY, CONFIG_ARCH_STRLEN, CONFIG_ARCH_STRNLEN - CONFIG_ARCH_BZERO - - If CONFIG_ARCH_MEMCPY is not selected, then you make also select Daniel - Vik's optimized implementation of memcpy(): - - CONFIG_MEMCPY_VIK - Select this option to use the optimized memcpy() - function by Daniel Vik. Select this option for improved performance - at the expense of increased size. See licensing information in the - top-level COPYING file. Default: n - - And if CONFIG_MEMCPY_VIK is selected, the following tuning options are available: - - CONFIG_MEMCPY_PRE_INC_PTRS - Use pre-increment of pointers. Default is - post increment of pointers. - - CONFIG_MEMCPY_INDEXED_COPY - Copying data using array indexing. Using - this option, disables the CONFIG_MEMCPY_PRE_INC_PTRS option. - - CONFIG_MEMCPY_64BIT - Compiles memcpy for architectures that suppport - 64-bit operations efficiently. - - If CONFIG_ARCH_MEMSET is not selected, then the following option is - also available: - - CONFIG_MEMSET_OPTSPEED - Select this option to use a version of memcpy() - optimized for speed. Default: memcpy() is optimized for size. - - And if CONFIG_MEMSET_OPTSPEED is selected, the following tuning option is - available: - - CONFIG_MEMSET_64BIT - Compiles memset() for architectures that suppport - 64-bit operations efficiently. - - The architecture may provide custom versions of certain standard header - files: - - CONFIG_ARCH_STDBOOL_H - The stdbool.h header file can be found at - nuttx/include/stdbool.h. However, that header includes logic to redirect - the inclusion of an architecture specific header file like: - - #ifdef CONFIG_ARCH_STDBOOL_H - # include <arch/stdbool.h> - #else - ... - #endif - - Recall that that include path, include/arch, is a symbolic link and - will refer to a version of stdbool.h at nuttx/arch/<architecture>/include/stdbool.h. - - CONFIG_ARCH_STDINT_H - Similar logic exists for the stdint.h header - file can also be found at nuttx/include/stdint.h. - - #ifdef CONFIG_ARCH_STDBOOL_H - # include <arch/stdinit.h> - #else - ... - #endif - - CONFIG_ARCH_MATH_H - There is also a re-directing version of math.h in - the source tree. However, it resides out-of-the-way at include/nuttx/math.h - because it conflicts too often with the system math.h. If CONFIG_ARCH_MATH_H=y - is defined, however, the top-level makefile will copy the redirecting - math.h header file from include/nuttx/math.h to include/math.h. math.h - will then include the architecture-specific version of math.h that you - must provide at nuttx/arch/>architecture</include/math.h. - - #ifdef CONFIG_ARCH_MATH_H - # include <arch/math.h> - #endif - - So for the architectures that define CONFIG_ARCH_MATH_H=y, include/math.h - will be the redirecting math.h header file; for the architectures that - don't select CONFIG_ARCH_MATH_H, the redirecting math.h header file will - stay out-of-the-way in include/nuttx/. - - CONFIG_ARCH_FLOAT_H - If you enable the generic, built-in math library, then that math library - will expect your toolchain to provide the standard float.h header file. - The float.h header file defines the properties of your floating point - implementation. It would always be best to use your toolchain's float.h - header file but if none is avaiable, a default float.h header file will - provided if this option is selected. However, there is no assurance that - the settings in this float.h are actually correct for your platform! - - CONFIG_ARCH_STDARG_H - There is also a redirecting version of stdarg.h in - the source tree as well. It also resides out-of-the-way at include/nuttx/stdarg.h. - This is because you should normally use your toolchain's stdarg.h file. But - sometimes, your toolchain's stdarg.h file may have other header file - dependencies and so may not be usable in the NuttX build environment. In - those cases, you may have to create a architecture-specific stdarg.h header - file at nuttx/arch/>architecture</include/stdarg.h - - If CONFIG_ARCH_STDARG_H=y is defined, the top-level makefile will copy the - re-directing stdarg.h header file from include/nuttx/stdarg.h to - include/stdarg.h. So for the architectures that cannot use their toolchain's - stdarg.h file, they can use this alternative by defining CONFIG_ARCH_STDARG_H=y - and providing. If CONFIG_ARCH_STDARG_H, is not defined, then the stdarg.h - header file will stay out-of-the-way in include/nuttx/. - - CONFIG_ARCH_ROMGETC - In Harvard architectures, data accesses and - instruction accesses occur on different busses, perhaps - concurrently. All data accesses are performed on the data bus - unless special machine instructions are used to read data - from the instruction address space. Also, in the typical - MCU, the available SRAM data memory is much smaller that the - non-volatile FLASH instruction memory. So if the application - requires many constant strings, the only practical solution may - be to store those constant strings in FLASH memory where they - can only be accessed using architecture-specific machine - instructions. - - If CONFIG_ARCH_ROMGETC is defined, then the architecture logic - must export the function up_romgetc(). up_romgetc() will simply - read one byte of data from the instruction space. - - If CONFIG_ARCH_ROMGETC, certain C stdio functions are effected: - (1) All format strings in printf, fprintf, sprintf, etc. are - assumed to lie in FLASH (string arguments for %s are still assumed - to reside in SRAM). And (2), the string argument to puts and fputs - is assumed to reside in FLASH. Clearly, these assumptions may have - to modified for the particular needs of your environment. There - is no "one-size-fits-all" solution for this problem. - - Sizes of configurable things (0 disables) - - CONFIG_MAX_TASKS - The maximum number of simultaneously - active tasks. This value must be a power of two. - CONFIG_NPTHREAD_KEYS - The number of items of thread- - specific data that can be retained - CONFIG_NFILE_DESCRIPTORS - The maximum number of file - descriptors (one for each open) - CONFIG_NFILE_STREAMS - The maximum number of streams that - can be fopen'ed - CONFIG_NAME_MAX - Maximum number of bytes in a filename (not including - terminating null). Default: 32 - CONFIG_PATH_MAX - Maximum number of bytes in a pathname, including the - terminating null character. Default: MIN(256,(4*CONFIG_NAME_MAX+1)) - CONFIG_STDIO_BUFFER_SIZE - Size of the buffer to allocate - on fopen. (Only if CONFIG_NFILE_STREAMS > 0) - CONFIG_STDIO_LINEBUFFER - If standard C buffered I/O is enabled - (CONFIG_STDIO_BUFFER_SIZE > 0), then this option may be added - to force automatic, line-oriented flushing the output buffer - for putc(), fputc(), putchar(), puts(), fputs(), printf(), - fprintf(), and vfprintf(). When a newline is encountered in - the output string, the output buffer will be flushed. This - (slightly) increases the NuttX footprint but supports the kind - of behavior that people expect for printf(). - CONFIG_NUNGET_CHARS - Number of characters that can be - buffered by ungetc() (Only if CONFIG_NFILE_STREAMS > 0) - CONFIG_PREALLOC_MQ_MSGS - The number of pre-allocated message - structures. The system manages a pool of preallocated - message structures to minimize dynamic allocations - CONFIG_PREALLOC_IGMPGROUPS - Pre-allocated IGMP groups are used - only if needed from interrupt level group created (by the IGMP server). - Default: 4. - CONFIG_MQ_MAXMSGSIZE - Message structures are allocated with - a fixed payload size given by this settin (does not include - other message structure overhead. - CONFIG_PREALLOC_WDOGS - The number of pre-allocated watchdog - structures. The system manages a pool of preallocated - watchdog structures to minimize dynamic allocations - CONFIG_DEV_PIPE_SIZE - Size, in bytes, of the buffer to allocated - for pipe and FIFO support - - Filesystem configuration - - CONFIG_FS_FAT - Enable FAT filesystem support - CONFIG_FAT_LCNAMES - Enable use of the NT-style upper/lower case 8.3 - file name support. - CONFIG_FAT_LFN - Enable FAT long file names. NOTE: Microsoft claims - patents on FAT long file name technology. Please read the - disclaimer in the top-level COPYING file and only enable this - feature if you understand these issues. - CONFIG_FAT_MAXFNAME - If CONFIG_FAT_LFN is defined, then the - default, maximum long file name is 255 bytes. This can eat up - a lot of memory (especially stack space). If you are willing - to live with some non-standard, short long file names, then - define this value. A good choice would be the same value as - selected for CONFIG_NAME_MAX which will limit the visibility - of longer file names anyway. - CONFIG_FS_FATTIME: Support FAT date and time. NOTE: There is not - much sense in supporting FAT date and time unless you have a - hardware RTC or other way to get the time and date. - CONFIG_FS_NXFFS: Enable NuttX FLASH file system (NXFF) support. - CONFIG_NXFFS_ERASEDSTATE: The erased state of FLASH. - This must have one of the values of 0xff or 0x00. - Default: 0xff. - CONFIG_NXFFS_PACKTHRESHOLD: When packing flash file data, - don't both with file chunks smaller than this number of data bytes. - Default: 32. - CONFIG_NXFFS_MAXNAMLEN: The maximum size of an NXFFS file name. - Default: 255. - CONFIG_NXFFS_PACKTHRESHOLD: When packing flash file data, - don't both with file chunks smaller than this number of data bytes. - Default: 32. - CONFIG_NXFFS_TAILTHRESHOLD: clean-up can either mean - packing files together toward the end of the file or, if file are - deleted at the end of the file, clean up can simply mean erasing - the end of FLASH memory so that it can be re-used again. However, - doing this can also harm the life of the FLASH part because it can - mean that the tail end of the FLASH is re-used too often. This - threshold determines if/when it is worth erased the tail end of FLASH - and making it available for re-use (and possible over-wear). - Default: 8192. - CONFIG_FS_ROMFS - Enable ROMFS filesystem support - CONFIG_NFS - Enable Network File System (NFS) client file system support. - Provided support is version 3 using UDP. In addition to common - prerequisites for mount-able file systems in general, this option - requires UDP networking support; this would include CONFIG_NETand - CONFIG_NET_UDP at a minimum. - CONFIG_FS_RAMMAP - For file systems that do not support XIP, this - option will enable a limited form of memory mapping that is - implemented by copying whole files into memory. - - RTC - - CONFIG_RTC - Enables general support for a hardware RTC. Specific - architectures may require other specific settings. - CONFIG_RTC_DATETIME - There are two general types of RTC: (1) A simple - battery backed counter that keeps the time when power is down, and (2) - A full date / time RTC the provides the date and time information, often - in BCD format. If CONFIG_RTC_DATETIME is selected, it specifies this - second kind of RTC. In this case, the RTC is used to "seed" the normal - NuttX timer and the NuttX system timer provides for higher resoution - time. - CONFIG_RTC_HIRES - If CONFIG_RTC_DATETIME not selected, then the simple, - battery backed counter is used. There are two different implementations - of such simple counters based on the time resolution of the counter: - The typical RTC keeps time to resolution of 1 second, usually - supporting a 32-bit time_t value. In this case, the RTC is used to - "seed" the normal NuttX timer and the NuttX timer provides for higher - resoution time. If CONFIG_RTC_HIRES is enabled in the NuttX configuration, - then the RTC provides higher resolution time and completely replaces the - system timer for purpose of date and time. - CONFIG_RTC_FREQUENCY - If CONFIG_RTC_HIRES is defined, then the frequency - of the high resolution RTC must be provided. If CONFIG_RTC_HIRES is - not defined, CONFIG_RTC_FREQUENCY is assumed to be one. - CONFIG_RTC_ALARM - Enable if the RTC hardware supports setting of an - alarm. A callback function will be executed when the alarm goes off - - CAN driver - - CONFIG_CAN - Enables CAN support (one or both of CONFIG_STM32_CAN1 or - CONFIG_STM32_CAN2 must also be defined) - CONFIG_CAN_EXTID - Enables support for the 29-bit extended ID. Default - Standard 11-bit IDs. - CONFIG_CAN_FIFOSIZE - The size of the circular buffer of CAN messages. - Default: 8 - CONFIG_CAN_NPENDINGRTR - The size of the list of pending RTR requests. - Default: 4 - CONFIG_CAN_LOOPBACK - A CAN driver may or may not support a loopback - mode for testing. If the driver does support loopback mode, the setting - will enable it. (If the driver does not, this setting will have no effect). - - SPI driver - - CONFIG_SPI_OWNBUS - Set if there is only one active device - on the SPI bus. No locking or SPI configuration will be performed. - It is not necessary for clients to lock, re-configure, etc.. - CONFIG_SPI_EXCHANGE - Driver supports a single exchange method - (vs a recvblock() and sndblock ()methods) - - SPI-based MMC/SD driver - - CONFIG_MMCSD_NSLOTS - Number of MMC/SD slots supported by the - driver. Default is one. - CONFIG_MMCSD_READONLY - Provide read-only access. Default is - Read/Write - CONFIG_MMCSD_SPICLOCK - Maximum SPI clock to drive MMC/SD card. - Default is 20MHz. - - SDIO/SDHC driver: - - CONFIG_SDIO_DMA - SDIO driver supports DMA - CONFIG_SDIO_MUXBUS - Set this SDIO interface if the SDIO interface - or hardware resources are shared with other drivers. - CONFIG_SDIO_WIDTH_D1_ONLY - Select 1-bit transfer mode. Default: - 4-bit transfer mode. - CONFIG_MMCSD_MULTIBLOCK_DISABLE - Use only the single block transfer method. - This setting is used to work around buggy SDIO drivers that cannot handle - multiple block transfers. - - SDIO-based MMC/SD driver - - CONFIG_FS_READAHEAD - Enable read-ahead buffering - CONFIG_FS_WRITEBUFFER - Enable write buffering - CONFIG_MMCSD_MMCSUPPORT - Enable support for MMC cards - CONFIG_MMCSD_HAVECARDDETECT - SDIO driver card detection is - 100% accurate - - RiT P14201 OLED driver - - CONFIG_LCD_P14201 - Enable P14201 support - CONFIG_P14201_SPIMODE - Controls the SPI mode - CONFIG_P14201_FREQUENCY - Define to use a different bus frequency - CONFIG_P14201_NINTERFACES - Specifies the number of physical P14201 - devices that will be supported. - CONFIG_P14201_FRAMEBUFFER - If defined, accesses will be performed - using an in-memory copy of the OLEDs GDDRAM. This cost of this - buffer is 128 * 96 / 2 = 6Kb. If this is defined, then the driver - will be fully functional. If not, then it will have the following - limitations: - - Reading graphics memory cannot be supported, and - - All pixel writes must be aligned to byte boundaries. - The latter limitation effectively reduces the 128x96 disply to 64x96. - - Nokia 6100 Configuration Settings: - - CONFIG_NOKIA6100_SPIMODE - Controls the SPI mode - CONFIG_NOKIA6100_FREQUENCY - Define to use a different bus frequency - CONFIG_NOKIA6100_NINTERFACES - Specifies the number of physical Nokia - 6100 devices that will be supported. - CONFIG_NOKIA6100_BPP - Device supports 8, 12, and 16 bits per pixel. - CONFIG_NOKIA6100_S1D15G10 - Selects the Epson S1D15G10 display controller - CONFIG_NOKIA6100_PCF8833 - Selects the Phillips PCF8833 display controller - CONFIG_NOKIA6100_BLINIT - Initial backlight setting - - The following may need to be tuned for your hardware: - CONFIG_NOKIA6100_INVERT - Display inversion, 0 or 1, Default: 1 - CONFIG_NOKIA6100_MY - Display row direction, 0 or 1, Default: 0 - CONFIG_NOKIA6100_MX - Display column direction, 0 or 1, Default: 1 - CONFIG_NOKIA6100_V - Display address direction, 0 or 1, Default: 0 - CONFIG_NOKIA6100_ML - Display scan direction, 0 or 1, Default: 0 - CONFIG_NOKIA6100_RGBORD - Display RGB order, 0 or 1, Default: 0 - - Required LCD driver settings: - CONFIG_LCD_NOKIA6100 - Enable Nokia 6100 support - CONFIG_LCD_MAXCONTRAST - must be 63 with the Epson controller and 127 with - the Phillips controller. - CONFIG_LCD_MAXPOWER - Maximum value of backlight setting. The backlight - control is managed outside of the 6100 driver so this value has no - meaning to the driver. Board-specific logic may place restrictions on - this value. - - Input Devices - - CONFIG_INPUT - Enables general support for input devices - - CONFIG_INPUT_TSC2007 - If CONFIG_INPUT is selected, then this setting will enable building - of the TI TSC2007 touchscreen driver. - CONFIG_TSC2007_MULTIPLE - Normally only a single TI TSC2007 touchscreen is used. But if - there are multiple TSC2007 touchscreens, this setting will enable - multiple touchscreens with the same driver. - - CONFIG_INPUT_STMPE811 - Enables support for the STMPE811 driver (Needs CONFIG_INPUT) - CONFIG_STMPE811_SPI - Enables support for the SPI interface (not currenly supported) - CONFIG_STMPE811_I2C - Enables support for the I2C interface - CONFIG_STMPE811_MULTIPLE - Can be defined to support multiple STMPE811 devices on board. - CONFIG_STMPE811_ACTIVELOW - Interrupt is generated by an active low signal (or falling edge). - CONFIG_STMPE811_EDGE - Interrupt is generated on an edge (vs. on the active level) - CONFIG_STMPE811_NPOLLWAITERS - Maximum number of threads that can be waiting on poll() (ignored if - CONFIG_DISABLE_POLL is set). - CONFIG_STMPE811_TSC_DISABLE - Disable driver touchscreen functionality. - CONFIG_STMPE811_ADC_DISABLE - Disable driver ADC functionality. - CONFIG_STMPE811_GPIO_DISABLE - Disable driver GPIO functionlaity. - CONFIG_STMPE811_GPIOINT_DISABLE - Disable driver GPIO interrupt functionality (ignored if GPIO - functionality is disabled). - CONFIG_STMPE811_SWAPXY - Reverse the meaning of X and Y to handle different LCD orientations. - CONFIG_STMPE811_TEMP_DISABLE - Disable driver temperature sensor functionality. - CONFIG_STMPE811_REGDEBUG - Enabled very low register-level debug output. Requires CONFIG_DEBUG. - CONFIG_STMPE811_THRESHX and CONFIG_STMPE811_THRESHY - STMPE811 touchscreen data comes in a a very high rate. New touch positions - will only be reported when the X or Y data changes by these thresholds. - This trades reduces data rate for some loss in dragging accuracy. The - STMPE811 is configure for 12-bit values so the raw ranges are 0-4095. So - for example, if your display is 320x240, then THRESHX=13 and THRESHY=17 - would correspond to one pixel. Default: 12 - - Analog Devices - - CONFIG_DAC - Enables general support for Digital-to-Analog conversion devices. - CONFIG_ADC - Enables general support for Analog-to-Digital conversion devices. - CONFIG_ADC_ADS125X - Adds support for the TI ADS 125x ADC. - - ENC28J60 Ethernet Driver Configuration Settings: - - CONFIG_ENC28J60 - Enabled ENC28J60 support - CONFIG_ENC28J60_SPIMODE - Controls the SPI mode - CONFIG_ENC28J60_FREQUENCY - Define to use a different bus frequency - CONFIG_ENC28J60_NINTERFACES - Specifies the number of physical ENC28J60 - devices that will be supported. - CONFIG_ENC28J60_STATS - Collect network statistics - CONFIG_ENC28J60_HALFDUPPLEX - Default is full duplex - - Networking support via uIP - - CONFIG_NET - Enable or disable all network features - CONFIG_NET_NOINTS -- CONFIG_NET_NOINT indicates that uIP not called from - the interrupt level. If CONFIG_NET_NOINTS is defined, critical sections - will be managed with semaphores; Otherwise, it assumed that uIP will be - called from interrupt level handling and critical sections will be - managed by enabling and disabling interrupts. - CONFIG_NET_MULTIBUFFER - Traditionally, uIP has used a single buffer - for all incoming and outgoing traffic. If this configuration is - selected, then the driver can manage multiple I/O buffers and can, - for example, be filling one input buffer while sending another - output buffer. Or, as another example, the driver may support - queuing of concurrent input/ouput and output transfers for better - performance. - CONFIG_NET_IPv6 - Build in support for IPv6 - CONFIG_NSOCKET_DESCRIPTORS - Maximum number of socket descriptors - per task/thread. - CONFIG_NET_NACTIVESOCKETS - Maximum number of concurrent socket - operations (recv, send, etc.). Default: CONFIG_NET_TCP_CONNS+CONFIG_NET_UDP_CONNS - CONFIG_NET_SOCKOPTS - Enable or disable support for socket options - - CONFIG_NET_BUFSIZE - uIP buffer size - CONFIG_NET_TCPURGDATA - Determines if support for TCP urgent data - notification should be compiled in. Urgent data (out-of-band data) - is a rarely used TCP feature that is very seldom would be required. - CONFIG_NET_TCP - TCP support on or off - CONFIG_NET_TCP_CONNS - Maximum number of TCP connections (all tasks) - CONFIG_NET_MAX_LISTENPORTS - Maximum number of listening TCP ports (all tasks) - CONFIG_NET_TCP_READAHEAD_BUFSIZE - Size of TCP read-ahead buffers - CONFIG_NET_NTCP_READAHEAD_BUFFERS - Number of TCP read-ahead buffers - (may be zero to disable TCP/IP read-ahead buffering) - CONFIG_NET_TCP_RECVDELAY - Delay (in deciseconds) after a TCP/IP packet - is received. This delay may allow catching of additional packets - when TCP/IP read-ahead is disabled. Default: 0 - CONFIG_NET_TCPBACKLOG - Incoming connections pend in a backlog until - accept() is called. The size of the backlog is selected when listen() - is called. - CONFIG_NET_UDP - UDP support on or off - CONFIG_NET_UDP_CHECKSUMS - UDP checksums on or off - CONFIG_NET_UDP_CONNS - The maximum amount of concurrent UDP - connections - CONFIG_NET_ICMP - Enable minimal ICMP support. Includes built-in support - for sending replies to received ECHO (ping) requests. - CONFIG_NET_ICMP_PING - Provide interfaces to support application level - support for sending ECHO (ping) requests and associating ECHO - replies. - CONFIG_NET_IGMP - Enable IGMPv2 client support. - CONFIG_PREALLOC_IGMPGROUPS - Pre-allocated IGMP groups are used - only if needed from interrupt level group created (by the IGMP server). - Default: 4. - CONFIG_NET_PINGADDRCONF - Use "ping" packet for setting IP address - CONFIG_NET_STATISTICS - uIP statistics on or off - CONFIG_NET_RECEIVE_WINDOW - The size of the advertised receiver's - window - CONFIG_NET_ARPTAB_SIZE - The size of the ARP table - CONFIG_NET_ARP_IPIN - Harvest IP/MAC address mappings from the ARP table - from incoming IP packets. - CONFIG_NET_BROADCAST - Incoming UDP broadcast support - CONFIG_NET_MULTICAST - Outgoing multi-cast address support - - SLIP Driver. SLIP 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: - - * The link level header (that comes before the IP header) is omitted. - * All MAC address processing is suppressed. - * ARP is disabled. - - 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). - - CONFIG_NET_SLIP -- Enables building of the SLIP driver. SLIP requires - at least one IP protocols selected and the following additional - network settings: CONFIG_NET_NOINTS and CONFIG_NET_MULTIBUFFER. - CONFIG_NET_BUFSIZE *must* be set to 296. Other optional configuration - settings that affect the SLIP driver: CONFIG_NET_STATISTICS. - Default: Ethernet - - If SLIP is selected, then the following SLIP options are available: - - CONFIG_CLIP_NINTERFACES -- Selects the number of physical SLIP - interfaces to support. Default: 1 - CONFIG_SLIP_STACKSIZE -- Select the stack size of the SLIP RX and - TX tasks. Default: 2048 - CONFIG_SLIP_DEFPRIO - The priority of the SLIP RX and TX tasks. - Default: 128 - - UIP Network Utilities - - CONFIG_NET_DHCP_LIGHT - Reduces size of DHCP - CONFIG_NET_RESOLV_ENTRIES - Number of resolver entries - CONFIG_NET_RESOLV_MAXRESPONSE - This setting determines the maximum - size of response message that can be received by the DNS resolver. - The default is 96 but may need to be larger on enterprise networks - (perhaps 176). - - THTTPD - - CONFIG_THTTPD_PORT - THTTPD Server port number - CONFIG_THTTPD_IPADDR - Server IP address (no host name) - CONFIG_THTTPD_SERVER_ADDRESS - SERVER_ADDRESS: response - CONFIG_THTTPD_SERVER_SOFTWARE - SERVER_SOFTWARE: response - CONFIG_THTTPD_PATH - Server working directory - CONFIG_THTTPD_CGI_PATH - Path to CGI executables - CONFIG_THTTPD_CGI_PATTERN - Only CGI programs matching this - pattern will be executed. In fact, if this value is not defined - then no CGI logic will be built. - CONFIG_THTTPD_CGI_PRIORITY - Provides the priority of CGI child tasks - CONFIG_THTTPD_CGI_STACKSIZE - Provides the initial stack size of - CGI child task (will be overridden by the stack size in the NXFLAT - header) - CONFIG_THTTPD_CGI_BYTECOUNT - Byte output limit for CGI tasks. - CONFIG_THTTPD_CGI_TIMELIMIT - How many seconds to allow CGI programs - to run before killing them. - CONFIG_THTTPD_CHARSET- The default character set name to use with - text MIME types. - CONFIG_THTTPD_IOBUFFERSIZE - - CONFIG_THTTPD_INDEX_NAMES - A list of index filenames to check. The - files are searched for in this order. - CONFIG_AUTH_FILE - The file to use for authentication. If this is - defined then thttpd checks for this file in the local directory - before every fetch. If the file exists then authentication is done, - otherwise the fetch proceeds as usual. If you leave this undefined - then thttpd will not implement authentication at all and will not - check for auth files, which saves a bit of CPU time. A typical - value is ".htpasswd" - CONFIG_THTTPD_LISTEN_BACKLOG - The listen() backlog queue length. - CONFIG_THTTPD_LINGER_MSEC - How many milliseconds to leave a connection - open while doing a lingering close. - CONFIG_THTTPD_OCCASIONAL_MSEC - How often to run the occasional - cleanup job. - CONFIG_THTTPD_IDLE_READ_LIMIT_SEC - How many seconds to allow for - reading the initial request on a new connection. - CONFIG_THTTPD_IDLE_SEND_LIMIT_SEC - How many seconds before an - idle connection gets closed. - CONFIG_THTTPD_TILDE_MAP1 and CONFIG_THTTPD_TILDE_MAP2 - Tilde mapping. - Many URLs use ~username to indicate a user's home directory. thttpd - provides two options for mapping this construct to an actual filename. - 1) Map ~username to <prefix>/username. This is the recommended choice. - Each user gets a subdirectory in the main web tree, and the tilde - construct points there. The prefix could be something like "users", - or it could be empty. - 2) Map ~username to <user's homedir>/<postfix>. The postfix would be - the name of a subdirectory off of the user's actual home dir, - something like "public_html". - You can also leave both options undefined, and thttpd will not do - anything special about tildes. Enabling both options is an error. - Typical values, if they're defined, are "users" for - CONFIG_THTTPD_TILDE_MAP1 and "public_html"forCONFIG_THTTPD_TILDE_MAP2. - CONFIG_THTTPD_GENERATE_INDICES - CONFIG_THTTPD_URLPATTERN - If defined, then it will be used to match - and verify referrers. - - FTP Server - - CONFIG_FTPD_VENDORID - The vendor name to use in FTP communications. - Default: "NuttX" - CONFIG_FTPD_SERVERID - The server name to use in FTP communications. - Default: "NuttX FTP Server" - CONFIG_FTPD_CMDBUFFERSIZE - The maximum size of one command. Default: - 128 bytes. - CONFIG_FTPD_DATABUFFERSIZE - The size of the I/O buffer for data - transfers. Default: 512 bytes. - CONFIG_FTPD_WORKERSTACKSIZE - The stacksize to allocate for each - FTP daemon worker thread. Default: 2048 bytes. - - Other required configuration settings: Of course TCP networking support - is required. But here are a couple that are less obvious: - - CONFIG_DISABLE_PTHREAD - pthread support is required - CONFIG_DISABLE_POLL - poll() support is required - - USB device controller driver - - CONFIG_USBDEV - Enables USB device support - CONFIG_USBDEV_COMPOSITE - Enables USB composite device support - CONFIG_USBDEV_ISOCHRONOUS - Build in extra support for isochronous - endpoints - CONFIG_USBDEV_DUALSPEED -Hardware handles high and full speed - operation (USB 2.0) - CONFIG_USBDEV_SELFPOWERED - Will cause USB features to indicate - that the device is self-powered - CONFIG_USBDEV_MAXPOWER - Maximum power consumption in mA - CONFIG_USBDEV_TRACE - Enables USB tracing for debug - CONFIG_USBDEV_TRACE_NRECORDS - Number of trace entries to remember - - USB host controller driver - - CONFIG_USBHOST - Enables USB host support - CONFIG_USBHOST_NPREALLOC - Number of pre-allocated class instances - CONFIG_USBHOST_BULK_DISABLE - On some architectures, selecting this setting will reduce driver size - by disabling bulk endpoint support - CONFIG_USBHOST_INT_DISABLE - On some architectures, selecting this setting will reduce driver size - by disabling interrupt endpoint support - CONFIG_USBHOST_ISOC_DISABLE - On some architectures, selecting this setting will reduce driver size - by disabling isochronous endpoint support - - 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. - - CONFIG_HIDKBD_POLLUSEC - Device poll rate in microseconds. Default: 100 milliseconds. - CONFIG_HIDKBD_DEFPRIO - Priority of the polling thread. Default: 50. - CONFIG_HIDKBD_STACKSIZE - Stack size for polling thread. Default: 1024 - CONFIG_HIDKBD_BUFSIZE - Scancode buffer size. Default: 64. - CONFIG_HIDKBD_NPOLLWAITERS - If the poll() method is enabled, this defines the maximum number - of threads that can be waiting for keyboard events. Default: 2. - CONFIG_HIDKBD_RAWSCANCODES - If set to y no conversion will be made on the raw keyboard scan - codes. Default: ASCII conversion. - CONFIG_HIDKBD_ALLSCANCODES' - If set to y all 231 possible scancodes will be converted to - something. Default: 104 key US keyboard. - CONFIG_HIDKBD_NODEBOUNCE - If set to y normal debouncing is disabled. Default: - Debounce enabled (No repeat keys). - - USB host mass storage class driver. Requires CONFIG_USBHOST=y, - CONFIG_USBHOST_BULK_DISABLE=n, CONFIG_NFILE_DESCRIPTORS > 0, - and CONFIG_SCHED_WORKQUEUE=y - - USB serial device class driver (Prolific PL2303 Emulation) - - CONFIG_PL2303 - Enable compilation of the USB serial driver - CONFIG_PL2303_EPINTIN - The logical 7-bit address of a hardware endpoint that supports - interrupt IN operation - CONFIG_PL2303_EPBULKOUT - The logical 7-bit address of a hardware endpoint that supports - bulk OUT operation - CONFIG_PL2303_EPBULKIN - The logical 7-bit address of a hardware endpoint that supports - bulk IN operation - CONFIG_PL2303_NWRREQS and CONFIG_PL2303_NRDREQS - The number of write/read requests that can be in flight - CONFIG_PL2303_VENDORID and CONFIG_PL2303_VENDORSTR - The vendor ID code/string - CONFIG_PL2303_PRODUCTID and CONFIG_PL2303_PRODUCTSTR - The product ID code/string - CONFIG_PL2303_RXBUFSIZE and CONFIG_PL2303_TXBUFSIZE - Size of the serial receive/transmit buffers - - USB serial device class driver (Standard CDC ACM class) - - CONFIG_CDCACM - Enable compilation of the USB serial driver - CONFIG_CDCACM_COMPOSITE - Configure the CDC serial driver as part of a composite driver - (only if CONFIG_USBDEV_COMPOSITE is also defined) - CONFIG_CDCACM_IFNOBASE - If the CDC driver is part of a composite device, then this may need to - be defined to offset the CDC/ACM interface numbers so that they are - unique and contiguous. When used with the Mass Storage driver, the - correct value for this offset is zero. - CONFIG_CDCACM_STRBASE - If the CDC driver is part of a composite device, then this may need to - be defined to offset the CDC/ACM string numbers so that they are - unique and contiguous. When used with the Mass Storage driver, the - correct value for this offset is four (this value actuallly only needs - to be defined if names are provided for the Notification interface, - CONFIG_CDCACM_NOTIFSTR, or the data interface, CONFIG_CDCACM_DATAIFSTR). - CONFIG_CDCACM_EP0MAXPACKET - Endpoint 0 max packet size. Default 64. - CONFIG_CDCACM_EPINTIN - The logical 7-bit address of a hardware endpoint that supports - interrupt IN operation. Default 2. - CONFIG_CDCACM_EPINTIN_FSSIZE - Max package size for the interrupt IN endpoint if full speed mode. - Default 64. - CONFIG_CDCACM_EPINTIN_HSSIZE - Max package size for the interrupt IN endpoint if high speed mode. - Default 64. - CONFIG_CDCACM_EPBULKOUT - The logical 7-bit address of a hardware endpoint that supports - bulk OUT operation - CONFIG_CDCACM_EPBULKOUT_FSSIZE - Max package size for the bulk OUT endpoint if full speed mode. - Default 64. - CONFIG_CDCACM_EPBULKOUT_HSSIZE - Max package size for the bulk OUT endpoint if high speed mode. - Default 512. - CONFIG_CDCACM_EPBULKIN - The logical 7-bit address of a hardware endpoint that supports - bulk IN operation - CONFIG_CDCACM_EPBULKIN_FSSIZE - Max package size for the bulk IN endpoint if full speed mode. - Default 64. - CONFIG_CDCACM_EPBULKIN_HSSIZE - Max package size for the bulk IN endpoint if high speed mode. - Default 512. - CONFIG_CDCACM_NWRREQS and CONFIG_CDCACM_NRDREQS - The number of write/read requests that can be in flight. - CONFIG_CDCACM_NWRREQS includes write requests used for both the - interrupt and bulk IN endpoints. Default 4. - CONFIG_CDCACM_VENDORID and CONFIG_CDCACM_VENDORSTR - The vendor ID code/string. Default 0x0525 and "NuttX" - 0x0525 is the Netchip vendor and should not be used in any - products. This default VID was selected for compatibility with - the Linux CDC ACM default VID. - CONFIG_CDCACM_PRODUCTID and CONFIG_CDCACM_PRODUCTSTR - The product ID code/string. Default 0xa4a7 and "CDC/ACM Serial" - 0xa4a7 was selected for compatibility with the Linux CDC ACM - default PID. - CONFIG_CDCACM_RXBUFSIZE and CONFIG_CDCACM_TXBUFSIZE - Size of the serial receive/transmit buffers. Default 256. - - USB Storage Device Configuration - - CONFIG_USBMSC - Enable compilation of the USB storage driver - CONFIG_USBMSC_COMPOSITE - Configure the mass storage driver as part of a composite driver - (only if CONFIG_USBDEV_COMPOSITE is also defined) - CONFIG_USBMSC_IFNOBASE - If the CDC driver is part of a composite device, then this may need to - be defined to offset the mass storage interface number so that it is - unique and contiguous. When used with the CDC/ACM driver, the - correct value for this offset is two (because of the two CDC/ACM - interfaces that will precede it). - CONFIG_USBMSC_STRBASE - If the CDC driver is part of a composite device, then this may need to - be defined to offset the mass storage string numbers so that they are - unique and contiguous. When used with the CDC/ACM driver, the - correct value for this offset is four (or perhaps 5 or 6, depending - on if CONFIG_CDCACM_NOTIFSTR or CONFIG_CDCACM_DATAIFSTR are defined). - CONFIG_USBMSC_EP0MAXPACKET - Max packet size for endpoint 0 - CONFIG_USBMSCEPBULKOUT and CONFIG_USBMSC_EPBULKIN - The logical 7-bit address of a hardware endpoints that support - bulk OUT and IN operations - CONFIG_USBMSC_NWRREQS and CONFIG_USBMSC_NRDREQS - The number of write/read requests that can be in flight - CONFIG_USBMSC_BULKINREQLEN and CONFIG_USBMSC_BULKOUTREQLEN - The size of the buffer in each write/read request. This - value needs to be at least as large as the endpoint - maxpacket and ideally as large as a block device sector. - CONFIG_USBMSC_VENDORID and CONFIG_USBMSC_VENDORSTR - The vendor ID code/string - CONFIG_USBMSC_PRODUCTID and CONFIG_USBMSC_PRODUCTSTR - The product ID code/string - CONFIG_USBMSC_REMOVABLE - Select if the media is removable - - USB Composite Device Configuration - - CONFIG_USBDEV_COMPOSITE - Enables USB composite device support - CONFIG_CDCACM_COMPOSITE - Configure the CDC serial driver as part of a composite driver - (only if CONFIG_USBDEV_COMPOSITE is also defined) - CONFIG_USBMSC_COMPOSITE - Configure the mass storage driver as part of a composite driver - (only if CONFIG_USBDEV_COMPOSITE is also defined) - CONFIG_COMPOSITE_IAD - If one of the members of the composite has multiple interfaces - (such as CDC/ACM), then an Interface Association Descriptor (IAD) - will be necessary. Default: IAD will be used automatically if - needed. It should not be necessary to set this. - CONFIG_COMPOSITE_EP0MAXPACKET - Max packet size for endpoint 0 - CONFIG_COMPOSITE_VENDORID and CONFIG_COMPOSITE_VENDORSTR - The vendor ID code/string - CONFIG_COMPOSITE_PRODUCTID and CONFIG_COMPOSITE_PRODUCTSTR - The product ID code/string - CONFIG_COMPOSITE_SERIALSTR - Device serial number string - CONFIG_COMPOSITE_CONFIGSTR - Configuration string - CONFIG_COMPOSITE_VERSIONNO - Interface version number. - - Graphics related configuration settings - - CONFIG_NX - Enables overall support for graphics library and NX - CONFIG_NX_MULTIUSER - Configures NX in multi-user mode - CONFIG_NX_NPLANES - Some YUV color formats requires support for multiple planes, - one for each color component. Unless you have such special - hardware, this value should be undefined or set to 1. - CONFIG_NX_DISABLE_1BPP, CONFIG_NX_DISABLE_2BPP, - CONFIG_NX_DISABLE_4BPP, CONFIG_NX_DISABLE_8BPP, - CONFIG_NX_DISABLE_16BPP, CONFIG_NX_DISABLE_24BPP, and - CONFIG_NX_DISABLE_32BPP - NX supports a variety of pixel depths. You can save some - memory by disabling support for unused color depths. - CONFIG_NX_PACKEDMSFIRST - If a pixel depth of less than 8-bits is used, then NX needs - to know if the pixels pack from the MS to LS or from LS to MS - CONFIG_NX_LCDDRIVER - By default, NX builds to use a framebuffer driver (see - include/nuttx/video/fb.h). If this option is defined, NX will - build to use an LCD driver (see include/nuttx/lcd/lcd.h). - CONFIG_LCD_MAXPOWER - The full-on power setting for an LCD - device. - CONFIG_LCD_MAXCONTRAST - The maximum contrast value for an - LCD device. - CONFIG_LCD_LANDSCAPE, CONFIG_LCD_PORTRAIT, CONFIG_LCD_RLANDSCAPE, - and CONFIG_LCD_RPORTRAIT - Some LCD drivers may support - these options to present the display in landscape, portrait, - reverse landscape, or reverse portrait orientations. Check - the README.txt file in each board configuration directory to - see if any of these are supported by the board LCD logic. - CONFIG_NX_MOUSE - Build in support for mouse input. - CONFIG_NX_KBD - Build in support of keypad/keyboard input. - CONFIG_NXTK_BORDERWIDTH - Specifies with with of the border (in pixels) used with - framed windows. The default is 4. - CONFIG_NXTK_BORDERCOLOR1 and CONFIG_NXTK_BORDERCOLOR2 - Specify the colors of the border used with framed windows. - CONFIG_NXTK_BORDERCOLOR2 is the shadow side color and so - is normally darker. The default is medium and dark grey, - respectively - CONFIG_NXTK_AUTORAISE - If set, a window will be raised to the top if the mouse position - is over a visible portion of the window. Default: A mouse - button must be clicked over a visible portion of the window. - CONFIG_NXFONTS_CHARBITS - The number of bits in the character set. Current options are - only 7 and 8. The default is 7. - - CONFIG_NXFONT_SANS23X27 - This option enables support for a tiny, 23x27 san serif font - (font ID FONTID_SANS23X27 == 1). - CONFIG_NXFONT_SANS22X29 - This option enables support for a small, 22x29 san serif font - (font ID FONTID_SANS22X29 == 2). - CONFIG_NXFONT_SANS28X37 - This option enables support for a medium, 28x37 san serif font - (font ID FONTID_SANS28X37 == 3). - CONFIG_NXFONT_SANS39X48 - This option enables support for a large, 39x48 san serif font - (font ID FONTID_SANS39X48 == 4). - CONFIG_NXFONT_SANS22X29B - This option enables support for a small, 22x29 san serif bold font - (font ID FONTID_SANS22X29B == 5). - CONFIG_NXFONT_SANS28X37B - This option enables support for a medium, 28x37 san serif bold font - (font ID FONTID_SANS28X37B == 6). - CONFIG_NXFONT_SANS40X49B - This option enables support for a large, 40x49 san serif bold font - (font ID FONTID_SANS40X49B == 7). - CONFIG_NXFONT_SERIF22X29 - This option enables support for a small, 22x29 font (with serifs) - (font ID FONTID_SERIF22X29 == 8). - CONFIG_NXFONT_SERIF29X37 - This option enables support for a medium, 29x37 font (with serifs) - (font ID FONTID_SERIF29X37 == 9). - CONFIG_NXFONT_SERIF38X48 - This option enables support for a large, 38x48 font (with serifs) - (font ID FONTID_SERIF38X48 == 10). - CONFIG_NXFONT_SERIF22X28B - This option enables support for a small, 27x38 bold font (with serifs) - (font ID FONTID_SERIF22X28B == 11). - CONFIG_NXFONT_SERIF27X38B - This option enables support for a medium, 27x38 bold font (with serifs) - (font ID FONTID_SERIF27X38B == 12). - CONFIG_NXFONT_SERIF38X49B - This option enables support for a large, 38x49 bold font (with serifs) - (font ID FONTID_SERIF38X49B == 13). - - NX Multi-user only options: - - CONFIG_NX_BLOCKING - Open the client message queues in blocking mode. In this case, - nx_eventhandler() will never return. - CONFIG_NX_MXSERVERMSGS and CONFIG_NX_MXCLIENTMSGS - Specifies the maximum number of messages that can fit in - the message queues. No additional resources are allocated, but - this can be set to prevent flooding of the client or server with - too many messages (CONFIG_PREALLOC_MQ_MSGS controls how many - messages are pre-allocated). - - Stack and heap information - - CONFIG_BOOT_RUNFROMFLASH - Some configurations support XIP - operation from FLASH but must copy initialized .data sections to RAM. - CONFIG_BOOT_COPYTORAM - Some configurations boot in FLASH - but copy themselves entirely into RAM for better performance. - CONFIG_ARCH_RAMFUNCS - Other configurations may copy just some functions - into RAM, either for better performance or for errata workarounds. - CONFIG_STACK_ALIGNMENT - Set if the your application has specific - stack alignment requirements (may not be supported - in all architectures). - CONFIG_IDLETHREAD_STACKSIZE - The size of the initial stack. - This is the thread that (1) performs the inital boot of the system up - to the point where user_start() is spawned, and (2) there after is the - IDLE thread that executes only when there is no other thread ready to - run. - CONFIG_USERMAIN_STACKSIZE - The size of the stack to allocate - for the main user thread that begins at the user_start() entry point. - CONFIG_PTHREAD_STACK_MIN - Minimum pthread stack size - CONFIG_PTHREAD_STACK_DEFAULT - Default pthread stack size +At one time, this section provided a list of all NuttX configuration +variables. However, NuttX has since converted to use the kconfig-frontends +tools (See http://ymorin.is-a-geek.org/projects/kconfig-frontends). Now, +the NuttX configuration is determined by a self-documenting set of Kconfig +files. + +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 an excruciatingly boring HTML document. + +The latest boring configuration variable documentation can be regenerated at +any time using that tool or, more appropriately, the wrapper script at +nuttx/tools/mkconfigvars.sh. That script will generate the file +nuttx/Documentation/NuttXConfigVariables.html. + +The version of NuttXConfigVariables.html for the last released version of +NuttX can also be found online at: +http://nuttx.org/Documentation/NuttXConfigVariables.html. Supported Boards ^^^^^^^^^^^^^^^^ @@ -2043,7 +515,7 @@ configs/stm32f100rc_generic chip. This "generic" configuration is not very usable out-of-box, but can be used as a starting point to creating new configs with similar STM32 high-density value line chips. - + configs/stm32f4discovery STMicro STM32F4-Discovery board based on the STMIcro STM32F407VGT6 MCU. |