michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Fix terminology in Kconfig files for 'platform'

Browse source 
Completing the terminology change started with change 4008
by updating the Kconfig files processed to produce the
online documentation, plus header files processed by
doxygen.  References to 'platform' are change to 'board'

Change-Id: Id0ed3dc1439a0ea0a4bd19d4904889cf79bec33e
Jira: ZEP-534
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2016-08-17 16:33:08 -07:00 • committed by Andrew Boie
commit d748577706
21 changed files with 45 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

24
arch/arc/Kconfig
View file

@ -169,56 +169,56 @@ config ICCM_SIZE
int "ICCM Size in kB" int "ICCM Size in kB"
help help
This option specifies the size of the ICCM in kB. It is normally set by This option specifies the size of the ICCM in kB. It is normally set by
the platform's defconfig file and the user should generally avoid modifying the board's defconfig file and the user should generally avoid modifying
it via the menu configuration. it via the menu configuration.
config ICCM_BASE_ADDRESS config ICCM_BASE_ADDRESS
hex "ICCM Base Address" hex "ICCM Base Address"
help help
This option specifies the base address of the ICCM on the platform. It is This option specifies the base address of the ICCM on the board. It is
normally set by the platform's defconfig file and the user should generally normally set by the board's defconfig file and the user should generally
avoid modifying it via the menu configuration. avoid modifying it via the menu configuration.
config DCCM_SIZE config DCCM_SIZE
int "DCCM Size in kB" int "DCCM Size in kB"
help help
This option specifies the size of the DCCM in kB. It is normally set by This option specifies the size of the DCCM in kB. It is normally set by
the platform's defconfig file and the user should generally avoid modifying the board's defconfig file and the user should generally avoid modifying
it via the menu configuration. it via the menu configuration.
config DCCM_BASE_ADDRESS config DCCM_BASE_ADDRESS
hex "DCCM Base Address" hex "DCCM Base Address"
help help
This option specifies the base address of the DCCM on the platform. It is This option specifies the base address of the DCCM on the board. It is
normally set by the platform's defconfig file and the user should generally normally set by the board's defconfig file and the user should generally
avoid modifying it via the menu configuration. avoid modifying it via the menu configuration.
config SRAM_SIZE config SRAM_SIZE
int "SRAM Size in kB" int "SRAM Size in kB"
help help
This option specifies the size of the SRAM in kB. It is normally set by This option specifies the size of the SRAM in kB. It is normally set by
the platform's defconfig file and the user should generally avoid modifying the board's defconfig file and the user should generally avoid modifying
it via the menu configuration. it via the menu configuration.
config SRAM_BASE_ADDRESS config SRAM_BASE_ADDRESS
hex "SRAM Base Address" hex "SRAM Base Address"
help help
This option specifies the base address of the SRAM on the platform. It is This option specifies the base address of the SRAM on the board. It is
normally set by the platform's defconfig file and the user should generally normally set by the board's defconfig file and the user should generally
avoid modifying it via the menu configuration. avoid modifying it via the menu configuration.
config FLASH_SIZE config FLASH_SIZE
int "Flash Size in kB" int "Flash Size in kB"
help help
This option specifies the size of the flash in kB. It is normally set by This option specifies the size of the flash in kB. It is normally set by
the platform's defconfig file and the user should generally avoid modifying the board's defconfig file and the user should generally avoid modifying
it via the menu configuration. it via the menu configuration.
config FLASH_BASE_ADDRESS config FLASH_BASE_ADDRESS
hex "Flash Base Address" hex "Flash Base Address"
help help
This option specifies the base address of the flash on the platform. It is This option specifies the base address of the flash on the board. It is
normally set by the platform's defconfig file and the user should generally normally set by the board's defconfig file and the user should generally
avoid modifying it via the menu configuration. avoid modifying it via the menu configuration.
config SW_ISR_TABLE config SW_ISR_TABLE

2
arch/arm/Kconfig
View file

@ -37,7 +37,7 @@ config ARCH_DEFCONFIG
source "arch/arm/core/Kconfig" source "arch/arm/core/Kconfig"
menu "Platform Configuration" menu "Board Configuration"
source "arch/arm/soc/*/Kconfig" source "arch/arm/soc/*/Kconfig"

20
arch/arm/core/cortex_m/Kconfig
View file

@ -79,7 +79,7 @@ config DATA_ENDIANNESS_LITTLE
default y default y
help help
This is driven by the processor implementation, since it is fixed in This is driven by the processor implementation, since it is fixed in
hardware. The platform should set this value to 'n' if the data is hardware. The board should set this value to 'n' if the data is
implemented as big endian. implemented as big endian.
config STACK_ALIGN_DOUBLE_WORD config STACK_ALIGN_DOUBLE_WORD
@ -92,12 +92,12 @@ config STACK_ALIGN_DOUBLE_WORD
config NUM_IRQ_PRIO_BITS config NUM_IRQ_PRIO_BITS
int int
#hidden option, implemented by platform #hidden option, implemented by board
help help
Cortex-M chips can implement up to 8 bits of interrupt priorities, Cortex-M chips can implement up to 8 bits of interrupt priorities,
for a maximum of 256 priorities. Most chips implement fewer than 8. for a maximum of 256 priorities. Most chips implement fewer than 8.
The platform must define the correct value. The board must define the correct value.
config RUNTIME_NMI config RUNTIME_NMI
bool bool
@ -132,28 +132,28 @@ config SRAM_SIZE
int "SRAM Size in kB" int "SRAM Size in kB"
help help
This option specifies the size of the SRAM in kB. It is normally set by This option specifies the size of the SRAM in kB. It is normally set by
the platform's defconfig file and the user should generally avoid modifying the board's defconfig file and the user should generally avoid modifying
it via the menu configuration. it via the menu configuration.
config SRAM_BASE_ADDRESS config SRAM_BASE_ADDRESS
hex "SRAM Base Address" hex "SRAM Base Address"
help help
This option specifies the base address of the SRAM on the platform. It is This option specifies the base address of the SRAM on the board. It is
normally set by the platform's defconfig file and the user should generally normally set by the board's defconfig file and the user should generally
avoid modifying it via the menu configuration. avoid modifying it via the menu configuration.
config FLASH_SIZE config FLASH_SIZE
int "Flash Size in kB" int "Flash Size in kB"
help help
This option specifies the size of the flash in kB. It is normally set by This option specifies the size of the flash in kB. It is normally set by
the platform's defconfig file and the user should generally avoid modifying the board's defconfig file and the user should generally avoid modifying
it via the menu configuration. it via the menu configuration.
config FLASH_BASE_ADDRESS config FLASH_BASE_ADDRESS
hex "Flash Base Address" hex "Flash Base Address"
help help
This option specifies the base address of the flash on the platform. It is This option specifies the base address of the flash on the board. It is
normally set by the platform's defconfig file and the user should generally normally set by the board's defconfig file and the user should generally
avoid modifying it via the menu configuration. avoid modifying it via the menu configuration.
endmenu endmenu
@ -197,7 +197,7 @@ config IRQ_VECTOR_TABLE_CUSTOM
depends on !SW_ISR_TABLE depends on !SW_ISR_TABLE
default n default n
help help
Projects, not the platform, provide the IRQ part of the vector table. Projects, not the board, provide the IRQ part of the vector table.
This is the table of interrupt handlers with the best potential This is the table of interrupt handlers with the best potential
performance, but is the less flexible. performance, but is the less flexible.

2
arch/nios2/Kconfig
View file

@ -113,7 +113,7 @@ config GP_ALL_DATA
bool "All data global pointer references" bool "All data global pointer references"
help help
Use GP relative access for all data in the program, not just Use GP relative access for all data in the program, not just
small data. Use this if your platform has 64K or less of RAM. small data. Use this if your board has 64K or less of RAM.
endchoice endchoice

2
arch/x86/Kconfig
View file

@ -236,7 +236,7 @@ config CACHE_FLUSHING
runtime. runtime.
endmenu endmenu
menu "Platform Capabilities" menu "Board Capabilities"
config NUM_DYNAMIC_STUBS config NUM_DYNAMIC_STUBS
int "Number of dynamic int stubs" int "Number of dynamic int stubs"
default 0 default 0

4
arch/x86/core/Kconfig
View file

@ -81,7 +81,7 @@ config RAM_SIZE
sections. When not running an XIP kernel, it must be large enough to sections. When not running an XIP kernel, it must be large enough to
contain the full image. contain the full image.
The default value is specified by the platform. The default value is specified by the board.
config ROM_SIZE config ROM_SIZE
int "Amount of ROM given to the kernel (in kB)" if XIP int "Amount of ROM given to the kernel (in kB)" if XIP
@ -90,7 +90,7 @@ config ROM_SIZE
not exceed the amount available on the target. It must also be large not exceed the amount available on the target. It must also be large
enough to contain the full image. enough to contain the full image.
The default value is specified by the platform. The default value is specified by the board.
config SET_GDT config SET_GDT
bool bool

2
drivers/gpio/Kconfig.qmsi
View file

@ -22,7 +22,7 @@ menuconfig GPIO_QMSI
default n default n
help help
Enable the GPIO driver found on Intel Microcontroller Enable the GPIO driver found on Intel Microcontroller
platforms, using the QMSI library. boards, using the QMSI library.
if GPIO_QMSI if GPIO_QMSI

2
drivers/gpio/Kconfig.sch
View file

@ -21,7 +21,7 @@ menuconfig GPIO_SCH
depends on GPIO depends on GPIO
default n default n
help help
Enable the SCH GPIO driver found on Intel platforms Enable the SCH GPIO driver found on Intel boards
if GPIO_SCH if GPIO_SCH

2
drivers/i2c/Kconfig
View file

@ -33,7 +33,7 @@ config I2C_DW
depends on I2C depends on I2C
default n default n
help help
Enable Design Ware I2C support on the selected platform Enable Design Ware I2C support on the selected board
config I2C_QUARK_SE_SS config I2C_QUARK_SE_SS
bool "I2C Driver for Quark SE Sensor Subsystem (SS)" bool "I2C Driver for Quark SE Sensor Subsystem (SS)"

2
drivers/pinmux/Kconfig
View file

@ -20,7 +20,7 @@
# PinMux options # PinMux options
# #
menuconfig PINMUX menuconfig PINMUX
bool "Enable platform pinmux driver" bool "Enable board pinmux driver"
default n default n
if PINMUX if PINMUX

2
drivers/pinmux/dev/Kconfig
View file

@ -66,7 +66,7 @@ config PINMUX_DEV_QMSI
bool "Enable QMSI pinmux dev driver" bool "Enable QMSI pinmux dev driver"
depends on PINMUX_DEV && QMSI depends on PINMUX_DEV && QMSI
help help
Enables the pinmux dev driver for QMSI supported platforms. Enables the pinmux dev driver for QMSI supported boards.
default n default n
config PINMUX_DEV_STM32 config PINMUX_DEV_STM32

2
drivers/random/Kconfig
View file

@ -44,7 +44,7 @@ config X86_TSC_RANDOM_GENERATOR
default y default y
help help
This options enables number generator based on timestamp counter This options enables number generator based on timestamp counter
of x86 platform, obtained with rdtsc instruction. of x86 boards, obtained with rdtsc instruction.
config TIMER_RANDOM_GENERATOR config TIMER_RANDOM_GENERATOR
bool bool

2
drivers/serial/Kconfig.k20
View file

@ -5,7 +5,7 @@ menuconfig UART_K20
help help
This option enables the K20 serial driver. This option enables the K20 serial driver.
This specific driver can be used for the serial hardware This specific driver can be used for the serial hardware
available at the Freescale FRDM K64F platform. available at the Freescale FRDM K64F board.
# ---------- Port 0 ---------- # ---------- Port 0 ----------

2
drivers/serial/Kconfig.ns16550
View file

@ -5,7 +5,7 @@ menuconfig UART_NS16550
help help
This option enables the NS16550 serial driver. This option enables the NS16550 serial driver.
This driver can be used for the serial hardware This driver can be used for the serial hardware
available on x86 platforms. available on x86 boards.
config UART_NS16550_PCI config UART_NS16550_PCI
bool "Enable PCI Support" bool "Enable PCI Support"

2
drivers/serial/Kconfig.stellaris
View file

@ -5,7 +5,7 @@ menuconfig UART_STELLARIS
help help
This option enables the Stellaris serial driver. This option enables the Stellaris serial driver.
This specific driver can be used for the serial hardware This specific driver can be used for the serial hardware
available at the Texas Instrument LM3S6965 platform. available at the Texas Instrument LM3S6965 board.
# ---------- Port 0 ---------- # ---------- Port 0 ----------

2
include/ipm.h
View file

@ -123,7 +123,7 @@ struct ipm_driver_api {
* @param ipmdev Driver instance * @param ipmdev Driver instance
* @param wait Time to busy-wait for remote to consume the message. * @param wait Time to busy-wait for remote to consume the message.
* @param id Message identifier. Values are constrained by * @param id Message identifier. Values are constrained by
* @a ipm_max_data_size_get since many platforms only allow for a * @a ipm_max_data_size_get since many boards only allow for a
* subset of bits in a 32-bit register to store the ID. * subset of bits in a 32-bit register to store the ID.
* @param data Pointer to the data sent in the message. * @param data Pointer to the data sent in the message.
* @param size Size of the data. * @param size Size of the data.

2
include/misc/kernel_event_logger.h
View file

@ -86,7 +86,7 @@ static inline uint32_t _sys_k_get_time(void)
* @details Calling this function permits to set the function * @details Calling this function permits to set the function
* to be called by kernel event logger for setting the event * to be called by kernel event logger for setting the event
* timestamp. By default, kernel event logger is using the * timestamp. By default, kernel event logger is using the
* system timer. But on some platforms where the timer driver * system timer. But on some boards where the timer driver
* maintains the system timer cycle accumulator in software, * maintains the system timer cycle accumulator in software,
* such as ones using the LOAPIC timer, the system timer behavior * such as ones using the LOAPIC timer, the system timer behavior
* leads to timestamp errors. For example, the timer interrupt is * leads to timestamp errors. For example, the timer interrupt is

6
kernel/Kconfig
View file

@ -41,7 +41,7 @@ config SYS_CLOCK_HW_CYCLES_PER_SEC
int "System clock's h/w timer frequency" int "System clock's h/w timer frequency"
help help
This option specifies the frequency of the hardware timer used for the This option specifies the frequency of the hardware timer used for the
system clock (in Hz). This option is set by the platform's Kconfig file system clock (in Hz). This option is set by the board's Kconfig file
and the user should generally avoid modifying it via the menu configuration. and the user should generally avoid modifying it via the menu configuration.
config SYS_CLOCK_EXISTS config SYS_CLOCK_EXISTS
@ -68,7 +68,7 @@ config XIP
prompt "Execute in place" prompt "Execute in place"
help help
This option allows the kernel to operate with its text and read-only This option allows the kernel to operate with its text and read-only
sections residing in ROM (or similar read-only memory). Not all platforms sections residing in ROM (or similar read-only memory). Not all boards
support this option so it must be used with care; you must also support this option so it must be used with care; you must also
supply a linker command file when building your image. Enabling this supply a linker command file when building your image. Enabling this
option increases both the code and data footprint of the image. option increases both the code and data footprint of the image.
@ -215,7 +215,7 @@ config SYS_POWER_MANAGEMENT
prompt "Power management" prompt "Power management"
default n default n
help help
This option enables the platform to implement extra power management This option enables the board to implement extra power management
policies whenever the kernel becomes idle. The kernel informs the policies whenever the kernel becomes idle. The kernel informs the
power management subsystem of the number of ticks until the next kernel power management subsystem of the number of ticks until the next kernel
timer is due to expire. timer is due to expire.

2
kernel/nanokernel/Kconfig
View file

@ -41,7 +41,7 @@ config INT_LATENCY_BENCHMARK
depends on ARCH="x86" depends on ARCH="x86"
help help
This option enables the tracking of interrupt latency metrics; This option enables the tracking of interrupt latency metrics;
the exact set of metrics being tracked is platform-dependent. the exact set of metrics being tracked is board-dependent.
Tracking begins when int_latency_init() is invoked by an application. Tracking begins when int_latency_init() is invoked by an application.
The metrics are displayed (and a new sampling interval is started) The metrics are displayed (and a new sampling interval is started)
each time int_latency_show() is called thereafter. each time int_latency_show() is called thereafter.

4
misc/Kconfig
View file

@ -37,7 +37,7 @@ config CUSTOM_LINKER_SCRIPT
depends on HAVE_CUSTOM_LINKER_SCRIPT depends on HAVE_CUSTOM_LINKER_SCRIPT
help help
Path to the linker script to be used instead of the one define by the Path to the linker script to be used instead of the one define by the
platform. board.
The linker script must be based on a version provided by Zephyr since The linker script must be based on a version provided by Zephyr since
the kernel can expect a certain layout/certain regions. the kernel can expect a certain layout/certain regions.
@ -381,7 +381,7 @@ config BOOTLOADER_UNKNOWN
This option signifies that the target has a generic bootloader This option signifies that the target has a generic bootloader
or that it supports multiple ways of booting and it isn't clear or that it supports multiple ways of booting and it isn't clear
at build time which method is to be used. When this option is enabled at build time which method is to be used. When this option is enabled
the platform may have to do extra work to ensure a proper startup. the board may have to do extra work to ensure a proper startup.
config REBOOT config REBOOT
bool "Reboot functionality" bool "Reboot functionality"

2
net/bluetooth/Kconfig
View file

@ -307,7 +307,7 @@ config BLUETOOTH_DEBUG_MONITOR
on the host side that can decode this protocol. Currently on the host side that can decode this protocol. Currently
the 'btmon' tool from BlueZ is capable of doing this. the 'btmon' tool from BlueZ is capable of doing this.
If the target platform has two or more external UARTs it is If the target board has two or more external UARTs it is
possible to keep using UART_CONSOLE together with this option, possible to keep using UART_CONSOLE together with this option,
however if there is only a single external UART then however if there is only a single external UART then
UART_CONSOLE needs to be disabled (in which case printk/printf UART_CONSOLE needs to be disabled (in which case printk/printf