Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2026-06-08 01:42:58 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Make sure that labeling is used consistently in all function headers.

Browse Source
This commit is contained in:
Gregory Nutt
2018-02-01 10:00:02 -06:00
parent a096bc1266
commit 7cf88d7dbd
1171 changed files with 3042 additions and 3039 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/hex2bin.h
+5 -5
View File
@@ -133,7 +133,7 @@ extern "C"
* swap - Controls byte ordering. See enum hex2bin_swap_e for
* description of the values.
*
* Returned Value
* Returned Value:
* Zero (OK) is returned on success; a negated errno value is returned on
* failure.
*
@@ -163,7 +163,7 @@ int hex2bin(FAR struct lib_instream_s *instream,
* swap - Controls byte ordering. See enum hex2bin_swap_e for
* description of the values.
*
* Returned Value
* Returned Value:
* Zero (OK) is returned on success; a negated errno value is returned on
* failure.
*
@@ -190,7 +190,7 @@ int hex2mem(int fd, uint32_t baseaddr, uint32_t endpaddr,
* swap - Controls byte ordering. See enum hex2bin_swap_e for
* description of the values.
*
* Returned Value
* Returned Value:
* Zero (OK) is returned on success; a negated errno value is returned on
* failure.
*
@@ -208,7 +208,7 @@ int fhex2mem(FAR FILE *instream, uint32_t baseaddr, uint32_t endpaddr,
* Input Parameters:
* Standard task inputs
*
* Returned Value
* Returned Value:
* EXIT_SUCESS on success; EXIT_FAILURE on failure
*
****************************************************************************/
@@ -226,7 +226,7 @@ int hex2bin_main(int argc, char **argv);
* Input Parameters:
* Standard task inputs
*
* Returned Value
* Returned Value:
* EXIT_SUCESS on success; EXIT_FAILURE on failure
*
****************************************************************************/
include/nuttx/analog/adc.h
+1 -1
View File
@@ -227,7 +227,7 @@ extern "C"
* driver with the "upper half" ADC device and registers that device so that can
* be used by application code.
*
* Input parameters:
* Input Parameters:
* path - The full path to the driver to be registers in the NuttX pseudo-
* filesystem. The recommended convention is to name all PWM drivers
* as "/dev/adc", "/dev/adc1", etc. where the driver path differs only
include/nuttx/analog/dac.h
+1 -1
View File
@@ -190,7 +190,7 @@ int dac_register(FAR const char *path, FAR struct dac_dev_s *dev);
* Input Parameters:
* dev - An instance of the device-specific DAC interface
*
* Return:
* Returned Value:
* OK on success; a negated errno on failure.
*
************************************************************************************/
include/nuttx/arch.h
+15 -15
View File
@@ -247,7 +247,7 @@ void up_initial_state(FAR struct tcb_s *tcb);
* - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of
* the stack pointer.
*
* Inputs:
* Input Parameters:
* - tcb: The TCB of new task
* - stack_size: The requested stack size. At least this much
* must be allocated.
@@ -289,7 +289,7 @@ int up_create_stack(FAR struct tcb_s *tcb, size_t stack_size, uint8_t ttype);
* - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The
* initial value of the stack pointer.
*
* Inputs:
* Input Parameters:
* - tcb: The TCB of new task
* - stack: The new stack to be used.
* - stack_size: The allocated stack size.
@@ -324,7 +324,7 @@ int up_use_stack(FAR struct tcb_s *tcb, FAR void *stack, size_t stack_size);
* been removed from the stack. This will still be the initial value
* of the stack pointer when the task is started.
*
* Inputs:
* Input Parameters:
* - tcb: The TCB of new task
* - frame_size: The size of the stack frame to allocate.
*
@@ -344,7 +344,7 @@ FAR void *up_stack_frame(FAR struct tcb_s *tcb, size_t frame_size);
* A task has been stopped. Free all stack related resources retained in
* the defunct TCB.
*
* Input Parmeters
* Input Parameters:
* - dtcb: The TCB containing information about the stack to be released
* - ttype: The thread type. This may be one of following (defined in
* include/nuttx/sched.h):
@@ -382,7 +382,7 @@ void up_release_stack(FAR struct tcb_s *dtcb, uint8_t ttype);
* logic. Interrupts will always be disabled when this
* function is called.
*
* Inputs:
* Input Parameters:
* tcb: Refers to the tcb to be unblocked. This tcb is
* in one of the waiting tasks lists. It must be moved to
* the ready-to-run list and, if it is the highest priority
@@ -404,7 +404,7 @@ void up_unblock_task(FAR struct tcb_s *tcb);
* logic. Interrupts will always be disabled when this
* function is called.
*
* Inputs:
* Input Parameters:
* tcb: Refers to a task in the ready-to-run list (normally
* the task at the head of the list). It most be
* stopped, its context saved and moved into one of the
@@ -455,7 +455,7 @@ void up_release_pending(void);
* logic. Interrupts will always be disabled when this
* function is called.
*
* Inputs:
* Input Parameters:
* tcb: The TCB of the task that has been reprioritized
* priority: The new task priority
*
@@ -601,12 +601,12 @@ void up_pthread_start(pthread_startroutine_t entrypt, pthread_addr_t arg)
* function is the user-space, signal handler trampoline function. It is
* called from up_signal_dispatch() in user-mode.
*
* Inputs:
* Input Parameters:
* sighand - The address user-space signal handling function
* signo, info, and ucontext - Standard arguments to be passed to the
* signal handling function.
*
* Return:
* Returned Value:
* None. This function does not return in the normal sense. It returns
* via an architecture specific system call made by up_signal_handler()
* (see below). However, this will look like a normal return by the
@@ -628,12 +628,12 @@ void up_signal_dispatch(_sa_sigaction_t sighand, int signo,
* must be provided by architecture-specific logic. It is called from
* up_signal_dispatch() in user-mode.
*
* Inputs:
* Input Parameters:
* sighand - The address user-space signal handling function
* signo, info, and ucontext - Standard arguments to be passed to the
* signal handling function.
*
* Return:
* Returned Value:
* None. This function does not return in the normal sense. It returns
* via an architecture specific system call.
*
@@ -1741,7 +1741,7 @@ int up_cpu_index(void);
* - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of
* the stack pointer.
*
* Inputs:
* Input Parameters:
* - cpu: CPU index that indicates which CPU the IDLE task is
* being created for.
* - tcb: The TCB of new CPU IDLE task
@@ -2015,10 +2015,10 @@ void sched_alarm_expiration(FAR const struct timespec *ts);
* Description:
* Collect data that can be used for CPU load measurements.
*
* Inputs:
* Input Parameters:
* None
*
* Return Value:
* Returned Value:
* None
*
* Assumptions/Limitations:
@@ -2054,7 +2054,7 @@ void irq_dispatch(int irq, FAR void *context);
* Input Parameters:
* None
*
* Returned value:
* Returned Value:
* The estimated amount of stack space used.
*
****************************************************************************/
include/nuttx/audio/audio.h
+2 -2
View File
@@ -670,7 +670,7 @@ extern "C"
* When this function is called, the "lower half" driver should be in the
* reset state (as if the shutdown() method had already been called).
*
* Input parameters:
* Input Parameters:
* name - The name of the audio device. This name will be used to generate
* a full path to the driver in the format "/dev/audio/[name]" in the NuttX
* filesystem (i.e. the path "/dev/audio" will be prepended to the supplied
@@ -695,7 +695,7 @@ int audio_register(FAR const char *name, FAR struct audio_lowerhalf_s *dev);
* Allocated an AP Buffer and prepares it for use. This allocates a dynamically
* allocated buffer that has no special DMA capabilities.
*
* Input parameters:
* Input Parameters:
* bufdesc: Pointer to a buffer descriptor
*
* Returned Value:
include/nuttx/audio/tone.h
+1 -1
View File
@@ -71,7 +71,7 @@ extern "C"
* be used by application code.
*
*
* Input parameters:
* Input Parameters:
* path - The full path to the driver to be registers in the NuttX pseudo-
* filesystem. The recommended convention is to name all PWM drivers
* as "/dev/tone0", "/dev/tone1", etc. where the driver path
include/nuttx/binfmt/binfmt.h
+1 -1
View File
@@ -271,7 +271,7 @@ int exec_module(FAR const struct binary_s *bin);
* or friends. It will also automatically free the structure with
* kmm_free() after unloading the module.
*
* Input Parameter:
* Input Parameters:
* pid - The task ID of the child task
* bin - This structure must have been allocated with kmm_malloc() and must
* persist until the task unloads
include/nuttx/binfmt/builtin.h
+3 -3
View File
@@ -117,7 +117,7 @@ void builtin_uninitialize(void);
* Description:
* Checks for availabiliy of application registerred during compile time.
*
* Input Parameter:
* Input Parameters:
* filename - Name of the linked-in binary to be started.
*
* Returned Value:
@@ -136,7 +136,7 @@ int builtin_isavail(FAR const char *appname);
* Returns pointer to a name of built-in application pointed by the
* index.
*
* Input Parameter:
* Input Parameters:
* index, from 0 and on ...
*
* Returned Value:
@@ -158,7 +158,7 @@ FAR const char *builtin_getname(int index);
* If support for builtin functions is enabled in the NuttX configuration,
* then this function must be provided by the application code.
*
* Input Parameter:
* Input Parameters:
* index, from 0 and on...
*
* Returned Value:
include/nuttx/cancelpt.h
+3 -3
View File
@@ -103,7 +103,7 @@ extern "C"
* Input Parameters:
* None
*
* Returned Value
* Returned Value:
* true is returned if a cancellation is pending but cannot be performed
* now due to the nesting level.
*
@@ -133,7 +133,7 @@ bool enter_cancellation_point(void);
* Input Parameters:
* None
*
* Returned Value
* Returned Value:
* None
*
****************************************************************************/
@@ -157,7 +157,7 @@ void leave_cancellation_point(void);
* Input Parameters:
* None
*
* Returned Value
* Returned Value:
* true is returned if a cancellation is pending but cannot be performed
* now due to the nesting level.
*
include/nuttx/clock.h
+5 -5
View File
@@ -272,7 +272,7 @@ EXTERN volatile systime_t g_system_timer;
* Parameters:
* None
*
* Return Value:
* Returned Value:
* None
*
* Assumptions:
@@ -302,7 +302,7 @@ void clock_synchronize(void);
* Parameters:
* diff: amount of time system-time is adjusted forward with RTC
*
* Return Value:
* Returned Value:
* None
*
* Assumptions:
@@ -329,7 +329,7 @@ void clock_resynchronize(FAR struct timespec *rtc_diff);
* Parameters:
* None
*
* Return Value:
* Returned Value:
* The current value of the system timer counter
*
* Assumptions:
@@ -350,7 +350,7 @@ systime_t clock_systimer(void);
* Parameters:
* ts - Location to return the time
*
* Return Value:
* Returned Value:
* Current version always returns OK
*
* Assumptions:
@@ -369,7 +369,7 @@ int clock_systimespec(FAR struct timespec *ts);
* pid - The task ID of the thread of interest. pid == 0 is the IDLE thread.
* cpuload - The location to return the CPU load
*
* Return Value:
* Returned Value:
* OK (0) on success; a negated errno value on failure. The only reason
* that this function can fail is if 'pid' no longer refers to a valid
* thread.
include/nuttx/crypto/aes.h
+2 -2
View File
@@ -75,7 +75,7 @@ extern "C"
* key AES128 key of size 16 bytes
* state 16 bytes of plain text and cipher text
*
* Returned Value
* Returned Value:
* None
*
****************************************************************************/
@@ -94,7 +94,7 @@ void aes_encrypt(FAR uint8_t *state, FAR const uint8_t *key);
* key AES128 key of size 16 bytes
* state 16 bytes of plain text and cipher text
*
* Returned Value
* Returned Value:
* None
*
****************************************************************************/
include/nuttx/drivers/drivers.h
+4 -4
View File
@@ -227,12 +227,12 @@ ssize_t bchlib_write(FAR void *handle, FAR const char *buffer, size_t offset,
* the NuttX FIFOs are based in in-memory, circular buffers, the ability
* to control the size of those buffers is critical for system tuning.
*
* Inputs:
* Input Parameters:
* fd[2] - The user provided array in which to catch the pipe file
* descriptors
* bufsize - The size of the in-memory, circular buffer in bytes.
*
* Return:
* Returned Value:
* 0 is returned on success; otherwise, -1 is returned with errno set
* appropriately.
*
@@ -264,13 +264,13 @@ int pipe2(int fd[2], size_t bufsize);
* the NuttX FIFOs are based in in-memory, circular buffers, the ability
* to control the size of those buffers is critical for system tuning.
*
* Inputs:
* Input Parameters:
* pathname - The full path to the FIFO instance to attach to or to create
* (if not already created).
* mode - Ignored for now
* bufsize - The size of the in-memory, circular buffer in bytes.
*
* Return:
* Returned Value:
* 0 is returned on success; otherwise, -1 is returned with errno set
* appropriately.
*
include/nuttx/drivers/pwm.h
+2 -2
View File
@@ -260,7 +260,7 @@ extern "C"
* When this function is called, the "lower half" driver should be in the
* reset state (as if the shutdown() method had already been called).
*
* Input parameters:
* Input Parameters:
* path - The full path to the driver to be registers in the NuttX pseudo-
* filesystem. The recommended convention is to name all PWM drivers
* as "/dev/pwm0", "/dev/pwm1", etc. where the driver path differs only
@@ -301,7 +301,7 @@ int pwm_register(FAR const char *path, FAR struct pwm_lowerhalf_s *dev);
* interface using the handle that was previously passed to the
* start() method
*
* Input parameters:
* Input Parameters:
* handle - This is the handle that was provided to the lower-half
* start() method.
*
include/nuttx/drivers/ramdisk.h
+2 -2
View File
@@ -79,14 +79,14 @@ extern "C"
* Description:
* Non-standard function to register a ramdisk or a romdisk
*
* Input Parmeters:
* Input Parameters:
* minor: Selects suffix of device named /dev/ramN, N={1,2,3...}
* nsectors: Number of sectors on device
* sectize: The size of one sector
* rdflags: See RDFLAG_* definitions
* buffer: RAM disk backup memory
*
* Returned Valued:
* Returned Value:
* Zero on success; a negated errno value on failure.
*
****************************************************************************/
include/nuttx/fs/fs.h
+3 -3
View File
@@ -496,7 +496,7 @@ void fs_initialize(void);
* Description:
* Register a character driver inode the pseudo file system.
*
* Input parameters:
* Input Parameters:
* path - The path to the inode to create
* fops - The file operations structure
* mode - inmode privileges (not used)
@@ -523,7 +523,7 @@ int register_driver(FAR const char *path,
* Description:
* Register a block driver inode the pseudo file system.
*
* Input parameters:
* Input Parameters:
* path - The path to the inode to create
* bops - The block driver operations structure
* mode - inmode privileges (not used)
@@ -1051,7 +1051,7 @@ int file_truncate(FAR struct file *filep, off_t length);
* req The ioctl command
* arg The argument of the ioctl cmd
*
* Return:
* Returned Value:
* Returns a non-negative number on success; A negated errno value is
* returned on any failure (see comments ioctl() for a list of appropriate
* errno values).
include/nuttx/fs/unionfs.h
+1 -1
View File
@@ -83,7 +83,7 @@ extern "C"
* file system appear a some path below the unionfs mountpoint,
* mountpt - The full path to the mountpoint for the union file system
*
* Returned value:
* Returned Value:
* Zero (OK) is returned if the union file system was correctly created and
* mounted. On any failure, a negated error value will be returned to
* indicate the nature of the failure.
include/nuttx/fs/userfs.h
+2 -2
View File
@@ -549,7 +549,7 @@ extern "C"
* NOTE: This is an OS internal function that should not be called from
* appliation logic.
*
* Input parameters:
* Input Parameters:
* None
*
* Returned Value:
@@ -584,7 +584,7 @@ int userfs_register(void);
* NOTE: This is a user function that is implemented as part of the
* NuttX C library and is intended to be called by appliation logic.
*
* Input parameters:
* Input Parameters:
* mountpt - Mountpoint path
* userops - The caller operations that implement the file system
* interface.
include/nuttx/input/ajoystick.h
+1 -1
View File
@@ -283,7 +283,7 @@ extern "C"
* lower - An instance of the platform-specific analog joystick lower
* half driver.
*
* Returned Values:
* Returned Value:
* Zero (OK) is returned on success. Otherwise a negated errno value is
* returned to indicate the nature of the failure.
*
include/nuttx/input/buttons.h
+1 -1
View File
@@ -191,7 +191,7 @@ extern "C"
* minor device number.
* lower - An instance of the platform-specific button lower half driver.
*
* Returned Values:
* Returned Value:
* Zero (OK) is returned on success. Otherwise a negated errno value is
* returned to indicate the nature of the failure.
*
include/nuttx/input/djoystick.h
+1 -1
View File
@@ -260,7 +260,7 @@ extern "C"
* lower - An instance of the platform-specific discrete joystick lower
* half driver.
*
* Returned Values:
* Returned Value:
* Zero (OK) is returned on success. Otherwise a negated errno value is
* returned to indicate the nature of the failure.
*
include/nuttx/input/nunchuck.h
+1 -1
View File
@@ -169,7 +169,7 @@ extern "C"
* minor device number.
* i2c - An instance of the platform-specific I2C connected to Nunchuck.
*
* Returned Values:
* Returned Value:
* Zero (OK) is returned on success. Otherwise a negated errno value is
* returned to indicate the nature of the failure.
*
include/nuttx/kthread.h
+2 -2
View File
@@ -97,7 +97,7 @@ extern "C"
* should be terminated with a NULL argv[] value. If no
* parameters are required, argv may be NULL.
*
* Return Value:
* Returned Value:
* Returns the positive, non-zero process ID of the new task or a negated
* errno value to indicate the nature of any failure. If memory is
* insufficient or the task cannot be created -ENOMEM will be returned.
@@ -126,7 +126,7 @@ int nxtask_create(FAR const char *name, int priority,
* should be terminated with a NULL argv[] value. If no
* parameters are required, argv may be NULL.
*
* Return Value:
* Returned Value:
* Returns the positive, non-zero process ID of the new task or a negated
* errno value to indicate the nature of any failure. If memory is
* insufficient or the task cannot be created -ENOMEM will be returned.
include/nuttx/leds/rgbled.h
+1 -1
View File
@@ -71,7 +71,7 @@ extern "C"
* be used by application code.
*
*
* Input parameters:
* Input Parameters:
* path - The full path to the driver to be registers in the NuttX pseudo-
* filesystem. The recommended convention is to name all PWM drivers
* as "/dev/rgdbled0", "/dev/rgbled1", etc. where the driver path
include/nuttx/leds/userled.h
+1 -1
View File
@@ -170,7 +170,7 @@ extern "C"
* minor device number.
* lower - An instance of the platform-specific LED lower half driver.
*
* Returned Values:
* Returned Value:
* Zero (OK) is returned on success. Otherwise a negated errno value is
* returned to indicate the nature of the failure.
*
include/nuttx/mqueue.h
+1 -1
View File
@@ -306,7 +306,7 @@ ssize_t nxmq_timedreceive(mqd_t mqdes, FAR char *msg, size_t msglen,
* closed so that no thread will attempt access it while it is being
* deleted.
*
* Inputs:
* Input Parameters:
* msgq - Named essage queue to be freed
*
* Returned Value:
include/nuttx/mtd/configdata.h
+1 -1
View File
@@ -117,7 +117,7 @@ extern "C"
* When this function is called, the MTD device pass in should already
* be initialized appropriately to access the physical device or partition.
*
* Input parameters:
* Input Parameters:
* mtd - Pointer to the MTD device to bind with the /dev/config device
*
* Returned Value:
include/nuttx/mtd/hamming.h
+2 -2
View File
@@ -108,7 +108,7 @@ extern "C"
* size - Data size in bytes
* code - Codes buffer
*
* Returned Values:
* Returned Value:
* None
*
****************************************************************************/
@@ -127,7 +127,7 @@ void hamming_compute256x(FAR const uint8_t *data, size_t size, uint8_t *code);
* size - Size of the data in bytes
* code - Original codes
*
* Returned Values:
* Returned Value:
* Return 0 if the data is correct, HAMMING_ERROR_SINGLEBIT if one or more
* block(s) have had a single bit corrected, or either HAMMING_ERROR_ECC
* or HAMMING_ERROR_MULTIPLEBITS.
include/nuttx/mtd/mtd.h
+1 -1
View File
@@ -243,7 +243,7 @@ extern "C"
* partitions, that mutual exclusion would be provided by the file system
* above the FLASH driver.
*
* Input parameters:
* Input Parameters:
* mtd - The MTD device to be partitioned
* firstblock - The offset in bytes to the first block
* nblocks - The number of blocks in the partition
include/nuttx/mtd/nand.h
+2 -2
View File
@@ -99,10 +99,10 @@ extern "C"
* Description:
* Probe and initialize NAND.
*
* Input parameters:
* Input Parameters:
* raw - Lower-half, raw NAND FLASH interface
*
* Returned value.
* Returned Value:
* A non-NULL MTD driver intstance is returned on success. NULL is
* returned on any failaure.
*
include/nuttx/mtd/nand_ecc.h
+4 -4
View File
@@ -86,14 +86,14 @@ extern "C"
* the spare area. If a buffer pointer is NULL, then the corresponding area
* is not saved.
*
* Input parameters:
* Input Parameters:
* nand - Upper-half, NAND FLASH interface
* block - Number of the block where the page to read resides.
* page - Number of the page to read inside the given block.
* data - Buffer where the data area will be stored.
* spare - Buffer where the spare area will be stored.
*
* Returned value.
* Returned Value:
* OK is returned in success; a negated errno value is returned on failure.
*
****************************************************************************/
@@ -111,14 +111,14 @@ int nandecc_readpage(FAR struct nand_dev_s *nand, off_t block,
* If no spare buffer is provided, the spare area is still written with the
* ECC information calculated on the data buffer.
*
* Input parameters:
* Input Parameters:
* nand - Upper-half, NAND FLASH interface
* block - Number of the block where the page to write resides.
* page - Number of the page to write inside the given block.
* data - Buffer containing the data to be writting
* spare - Buffer containing the spare data to be written.
*
* Returned value.
* Returned Value:
* OK is returned in success; a negated errno value is returned on failure.
*
****************************************************************************/
include/nuttx/mtd/nand_model.h
+15 -15
View File
@@ -127,7 +127,7 @@ EXTERN const struct nand_model_s g_nandmodels[NAND_NMODELS];
* chipid Identifier returned by the Nand(id1|(id2<<8)|(id3<<16)|(id4<<24)).
* model nand_model_s instance to update with the model parameters.
*
* Returned Values:
* Returned Value:
* OK is returned on success; -ENODEV is returned on failure.
*
****************************************************************************/
@@ -151,7 +151,7 @@ int nandmodel_find(FAR const struct nand_model_s *modeltab, size_t size,
* page Stores the first accessed page number inside the first block.
* offset Stores the byte offset inside the first accessed page.
*
* Returned Values:
* Returned Value:
* OK on success; -EPIPE on failure.
*
****************************************************************************/
@@ -170,7 +170,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address,
* Input Parameters:
* model Pointer to a nand_model_s instance.
*
* Returned Values:
* Returned Value:
* Spare placement scheme
*
****************************************************************************/
@@ -186,7 +186,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address,
* Input Parameters:
* model Pointer to a nand_model_s instance.
*
* Returned Values:
* Returned Value:
* Device ID
*
****************************************************************************/
@@ -202,7 +202,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address,
* Input Parameters:
* model Pointer to a nand_model_s instance.
*
* Returned Values:
* Returned Value:
* Number of blocks in the device
*
****************************************************************************/
@@ -220,7 +220,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address,
* Input Parameters:
* model Pointer to a nand_model_s instance.
*
* Returned Values:
* Returned Value:
* Size of the device in bytes
*
****************************************************************************/
@@ -237,7 +237,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address,
* Input Parameters:
* model Pointer to a nand_model_s instance.
*
* Returned Values:
* Returned Value:
* size of the device in MB.
*
****************************************************************************/
@@ -253,7 +253,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address,
* Input Parameters:
* model Pointer to a nand_model_s instance.
*
* Returned Values:
* Returned Value:
* Block size in pages
*
****************************************************************************/
@@ -270,7 +270,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address,
* Input Parameters:
* model Pointer to a nand_model_s instance.
*
* Returned Values:
* Returned Value:
* Number of pages in the device
*
****************************************************************************/
@@ -288,7 +288,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address,
* Input Parameters:
* model Pointer to a nand_model_s instance.
*
* Returned Values:
* Returned Value:
* Block size in bytes
*
****************************************************************************/
@@ -304,7 +304,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address,
* Input Parameters:
* model Pointer to a nand_model_s instance.
*
* Returned Values:
* Returned Value:
* Size of data area in bytes
*
****************************************************************************/
@@ -320,7 +320,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address,
* Input Parameters:
* model Pointer to a nand_model_s instance.
*
* Returned Values:
* Returned Value:
* size of spare area in bytes
*
****************************************************************************/
@@ -336,7 +336,7 @@ unsigned int nandmodel_getsparesize(FAR const struct nand_model_s *model);
* Input Parameters:
* model Pointer to a nand_model_s instance.
*
* Returned Values:
* Returned Value:
* data width
*
****************************************************************************/
@@ -354,7 +354,7 @@ unsigned int nandmodel_getsparesize(FAR const struct nand_model_s *model);
* Input Parameters:
* model Pointer to a nand_model_s instance.
*
* Returned Values:
* Returned Value:
* Returns true if the given NAND FLASH model uses the "small blocks/pages"
* command set; otherwise returns false.
*
@@ -372,7 +372,7 @@ unsigned int nandmodel_getsparesize(FAR const struct nand_model_s *model);
* Input Parameters:
* model Pointer to a nand_model_s instance.
*
* Returned Values:
* Returned Value:
* Returns true if the device supports the copy-back operation. Otherwise
* returns false.
*
include/nuttx/mtd/nand_raw.h
+10 -10
View File
@@ -128,11 +128,11 @@
* Description:
* Erases the specified block of the device.
*
* Input parameters:
* Input Parameters:
* raw - Lower-half, raw NAND FLASH interface
* block - Number of the physical block to erase.
*
* Returned value.
* Returned Value:
* OK is returned in succes; a negated errno value is returned on failure.
*
****************************************************************************/
@@ -146,14 +146,14 @@
* Reads the data and/or the spare areas of a page of a NAND FLASH into the
* provided buffers. This is a raw read of the flash contents.
*
* Input parameters:
* Input Parameters:
* raw - Lower-half, raw NAND FLASH interface
* block - Number of the block where the page to read resides.
* page - Number of the page to read inside the given block.
* data - Buffer where the data area will be stored.
* spare - Buffer where the spare area will be stored.
*
* Returned value.
* Returned Value:
* OK is returned in succes; a negated errno value is returned on failure.
*
****************************************************************************/
@@ -167,14 +167,14 @@
* Writes the data and/or the spare area of a page on a NAND FLASH chip.
* This is a raw write of the flash contents.
*
* Input parameters:
* Input Parameters:
* raw - Lower-half, raw NAND FLASH interface
* block - Number of the block where the page to write resides.
* page - Number of the page to write inside the given block.
* data - Buffer containing the data to be writting
* spare - Buffer containing the spare data to be written.
*
* Returned value.
* Returned Value:
* OK is returned in succes; a negated errno value is returned on failure.
*
****************************************************************************/
@@ -189,14 +189,14 @@
* provided buffers. Hardware ECC checking will be performed if so
* configured.
*
* Input parameters:
* Input Parameters:
* raw - Lower-half, raw NAND FLASH interface
* block - Number of the block where the page to read resides.
* page - Number of the page to read inside the given block.
* data - Buffer where the data area will be stored.
* spare - Buffer where the spare area will be stored.
*
* Returned value.
* Returned Value:
* OK is returned in succes; a negated errno value is returned on failure.
*
****************************************************************************/
@@ -214,14 +214,14 @@
* Writes the data and/or the spare area of a page on a NAND FLASH chip.
* Hardware ECC checking will be performed if so configured.
*
* Input parameters:
* Input Parameters:
* raw - Lower-half, raw NAND FLASH interface
* block - Number of the block where the page to write resides.
* page - Number of the page to write inside the given block.
* data - Buffer containing the data to be writting
* spare - Buffer containing the spare data to be written.
*
* Returned value.
* Returned Value:
* OK is returned in succes; a negated errno value is returned on failure.
*
****************************************************************************/
include/nuttx/mtd/nand_scheme.h
+11 -11
View File
@@ -109,7 +109,7 @@ EXTERN const struct nand_scheme_s g_nand_sparescheme4096;
* spare Spare area buffer.
* marker Pointer to the variable to store the bad block marker.
*
* Returned Values:
* Returned Value:
* None
*
****************************************************************************/
@@ -130,7 +130,7 @@ void nandscheme_readbadblockmarker(FAR const struct nand_scheme_s *scheme,
* spare Spare area buffer.
* marker Bad block marker to write.
*
* Returned Values:
* Returned Value:
* None
*
****************************************************************************/
@@ -150,7 +150,7 @@ void nandscheme_writebadblockmarker(FAR const struct nand_scheme_s *scheme,
* Input Parameters:
* scheme Pointer to a nand_scheme_s instance.
*
* Returned Values:
* Returned Value:
* Offset in the spare area to the first ECC byte
*
****************************************************************************/
@@ -166,7 +166,7 @@ void nandscheme_writebadblockmarker(FAR const struct nand_scheme_s *scheme,
* Input Parameters:
* scheme Pointer to a nand_scheme_s instance.
*
* Returned Values:
* Returned Value:
* Size of the ECC information in the spare area.
*
****************************************************************************/
@@ -184,7 +184,7 @@ void nandscheme_writebadblockmarker(FAR const struct nand_scheme_s *scheme,
* spare Spare area buffer.
* ecc ECC buffer.
*
* Returned Values:
* Returned Value:
* None
*
****************************************************************************/
@@ -203,7 +203,7 @@ void nandscheme_readecc(FAR const struct nand_scheme_s *scheme,
* spare Spare area buffer.
* ecc ECC buffer.
*
* Returned Values:
* Returned Value:
* None
*
****************************************************************************/
@@ -223,7 +223,7 @@ void nandscheme_writeecc(FAR const struct nand_scheme_s *scheme,
* Input Parameters:
* scheme Pointer to a nand_scheme_s instance.
*
* Returned Values:
* Returned Value:
* Offset in the spare area to the first extra byte
*
****************************************************************************/
@@ -239,7 +239,7 @@ void nandscheme_writeecc(FAR const struct nand_scheme_s *scheme,
* Input Parameters:
* scheme Pointer to a nand_scheme_s instance.
*
* Returned Values:
* Returned Value:
* Size of the extra information in the spare area.
*
****************************************************************************/
@@ -260,7 +260,7 @@ void nandscheme_writeecc(FAR const struct nand_scheme_s *scheme,
* size Number of extra bytes to read.
* offset Index where to read the first extra byte.
*
* Returned Values:
* Returned Value:
* None
*
****************************************************************************/
@@ -283,7 +283,7 @@ void nandscheme_readextra(FAR const struct nand_scheme_s *scheme,
* size Number of extra bytes to write.
* offset Index where to write the first extra byte.
*
* Returned Values:
* Returned Value:
* None
*
****************************************************************************/
@@ -305,7 +305,7 @@ void nandscheme_writeextra(FAR const struct nand_scheme_s *scheme,
* size Number of extra bytes to write.
* offset Index where to write the first extra byte.
*
* Returned Values:
* Returned Value:
* OK on success; a negated errno value on failure.
*
****************************************************************************/
include/nuttx/net/ieee802154.h
+1 -1
View File
@@ -71,7 +71,7 @@
* If there are multilple frames in the list, this metadata
* must apply to all of the frames in the list.
*
* Return:
* Returned Value:
* OK The IEEE 802.15.4 has been processed and can be deleted
* ERROR Hold the IEEE 802.15.4 and try again later. There is a listening
* socket but no recv in place to catch the IEEE 802.15.4 yet.
include/nuttx/net/net.h
+6 -6
View File
@@ -306,7 +306,7 @@ void net_initialize(void);
* Input Parameters:
* None
*
* Returned value:
* Returned Value:
* None
*
****************************************************************************/
@@ -322,7 +322,7 @@ void net_lock(void);
* Input Parameters:
* None
*
* Returned value:
* Returned Value:
* None
*
****************************************************************************/
@@ -340,7 +340,7 @@ void net_unlock(void);
* sem - A reference to the semaphore to be taken.
* abstime - The absolute time to wait until a timeout is declared.
*
* Returned value:
* Returned Value:
* Zero (OK) is returned on success; a negated errno value is returned on
* any failure.
*
@@ -358,7 +358,7 @@ int net_timedwait(sem_t *sem, FAR const struct timespec *abstime);
* Input Parameters:
* sem - A reference to the semaphore to be taken.
*
* Returned value:
* Returned Value:
* Zero (OK) is returned on success; a negated errno value is returned on
* any failure.
*
@@ -1037,7 +1037,7 @@ int psock_setsockopt(FAR struct socket *psock, int level, int option,
* cmd The ioctl command
* arg The argument of the ioctl cmd
*
* Return:
* Returned Value:
* A non-negative value is returned on success; a negated errno value is
* returned on any failure to indicate the nature of the failure:
*
@@ -1070,7 +1070,7 @@ int psock_ioctl(FAR struct socket *psock, int cmd, unsigned long arg);
* cmd The ioctl command
* arg The argument of the ioctl cmd
*
* Return:
* Returned Value:
* A non-negative value is returned on success; a negated errno value is
* returned on any failure to indicate the nature of the failure:
*
include/nuttx/net/pkt.h
+1 -1
View File
@@ -73,7 +73,7 @@
* Parameters:
* dev - The device driver structure containing the received packet
*
* Return:
* Returned Value:
* OK The packet has been processed and can be deleted
* ERROR There is a matching connection, but could not dispatch the packet
* yet. Useful when a packet arrives before a recv call is in
include/nuttx/net/radiodev.h
+3 -3
View File
@@ -189,7 +189,7 @@ struct radio_driver_s
* Description:
* Calculate the MAC header length given the frame meta-data.
*
* Input parameters:
* Input Parameters:
* netdev - The networkd device that will mediate the MAC interface
* meta - Obfuscated metadata structure needed to recreate the
* radio MAC header
@@ -209,7 +209,7 @@ struct radio_driver_s
* Description:
* Requests the transfer of a list of frames to the MAC.
*
* Input parameters:
* Input Parameters:
* netdev - The network device that will mediate the MAC interface
* meta - Obfuscated metadata structure needed to create the radio
* MAC header
@@ -233,7 +233,7 @@ struct radio_driver_s
* run time. This information is provided to the 6LoWPAN network via the
* following structure.
*
* Input parameters:
* Input Parameters:
* netdev - The network device to be queried
* properties - Location where radio properities will be returned.
*
include/nuttx/net/telnet.h
+1 -1
View File
@@ -85,7 +85,7 @@ struct telnet_session_s
* Parameters:
* None
*
* Return:
* Returned Value:
* Zero (OK) on success; a negated errno value on failure.
*
****************************************************************************/
include/nuttx/nx/nx.h
+28 -28
View File
@@ -260,7 +260,7 @@ extern "C"
* mqname - The name for the server incoming message queue
* dev - Vtable "object" of the framebuffer "driver" to use
*
* Return:
* Returned Value:
* This function usually does not return. If it does return, it will
* return ERROR and errno will be set appropriately.
*
@@ -315,7 +315,7 @@ int nx_start(void);
* Input Parameters:
* svrmqname - The name for the server incoming message queue
*
* Return:
* Returned Value:
* Success: A non-NULL handle used with subsequent NX accesses
* Failure: NULL is returned and errno is set appropriately
*
@@ -334,7 +334,7 @@ NXHANDLE nx_connectinstance(FAR const char *svrmqname);
* Input Parameters:
* handle - the handle returned by nx_connect
*
* Return:
* Returned Value:
* None
*
****************************************************************************/
@@ -358,7 +358,7 @@ void nx_disconnect(NXHANDLE handle);
* Input Parameters:
* handle - the handle returned by nx_connect
*
* Return:
* Returned Value:
* OK: No errors occurred. If CONFIG_NX_BLOCKING is defined, then
* one or more server messages were processed.
* ERROR: An error occurred and errno has been set appropriately. Of
@@ -385,7 +385,7 @@ int nx_eventhandler(NXHANDLE handle);
* Input Parameters:
* handle - the handle returned by nx_connect
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -407,7 +407,7 @@ int nx_eventnotify(NXHANDLE handle, int signo);
* cb - Callbacks used to process window events
* arg - User provided value that will be returned with NX callbacks.
*
* Return:
* Returned Value:
* Success: A non-NULL handle used with subsequent NX accesses
* Failure: NULL is returned and errno is set appropriately
*
@@ -425,7 +425,7 @@ NXWINDOW nx_openwindow(NXHANDLE handle, FAR const struct nx_callback_s *cb,
* Input Parameters:
* wnd - The window to be destroyed
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -456,7 +456,7 @@ int nx_closewindow(NXWINDOW hwnd);
* arg - An argument that will accompany the block messages (This is arg2
* in the blocked callback).
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -497,7 +497,7 @@ int nx_block(NXWINDOW hwnd, FAR void *arg);
* cb - Callbacks to use for processing background window events
* arg - User provided value that will be returned with NX callbacks.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -515,7 +515,7 @@ int nx_requestbkgd(NXHANDLE handle, FAR const struct nx_callback_s *cb,
* Input Parameters:
* hwnd - The handle returned (indirectly) by nx_requestbkgd
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -533,7 +533,7 @@ int nx_releasebkgd(NXWINDOW hwnd);
* Input Parameters:
* hwnd - The window handle
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -550,7 +550,7 @@ int nx_getposition(NXWINDOW hwnd);
* hwnd - The window handle
* pos - The new position of the window
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -567,7 +567,7 @@ int nx_setposition(NXWINDOW hwnd, FAR const struct nxgl_point_s *pos);
* hwnd - The window handle
* size - The new size of the window.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -580,10 +580,10 @@ int nx_setsize(NXWINDOW hwnd, FAR const struct nxgl_size_s *size);
* Description:
* Bring the specified window to the top of the display.
*
* Input parameters:
* Input Parameters:
* hwnd - the window to be raised
*
* Returned value:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -596,10 +596,10 @@ int nx_raise(NXWINDOW hwnd);
* Description:
* Lower the specified window to the bottom of the display.
*
* Input parameters:
* Input Parameters:
* hwnd - the window to be lowered
*
* Returned value:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -618,7 +618,7 @@ int nx_lower(NXWINDOW hwnd);
* pos - The pixel location to be set
* col - The color to use in the set
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -637,7 +637,7 @@ int nx_setpixel(NXWINDOW hwnd, FAR const struct nxgl_point_s *pos,
* rect - The location to be filled
* color - The color to use in the fill
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -666,7 +666,7 @@ int nx_fill(NXWINDOW hwnd, FAR const struct nxgl_rect_s *rect,
* rect - The location to be filled
* color - The color to use in the fill
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -687,7 +687,7 @@ int nx_getrectangle(NXWINDOW hwnd, FAR const struct nxgl_rect_s *rect,
* trap - The trapezoidal region to be filled
* color - The color to use in the fill
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -712,7 +712,7 @@ int nx_filltrapezoid(NXWINDOW hwnd, FAR const struct nxgl_rect_s *clip,
* caps - Draw a circular on the both ends of the line to support better
* line joins
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -734,7 +734,7 @@ int nx_drawline(NXWINDOW hwnd, FAR struct nxgl_vector_s *vector,
* width - The width of the line
* color - The color to use to fill the line
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -755,7 +755,7 @@ int nx_drawcircle(NXWINDOW hwnd, FAR const struct nxgl_point_s *center,
* radius - The radius of the circle in pixels.
* color - The color to use to fill the circle
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -774,7 +774,7 @@ int nx_fillcircle(NXWINDOW hwnd, FAR const struct nxgl_point_s *center,
* handle - The connection handle
* color - The color to use in the background
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -793,7 +793,7 @@ int nx_setbgcolor(NXHANDLE handle, nxgl_mxpixel_t color[CONFIG_NX_NPLANES]);
* offset - The offset to move the region. The rectangular region will be
* moved so that the origin is translated by this amount.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -819,7 +819,7 @@ int nx_move(NXWINDOW hwnd, FAR const struct nxgl_rect_s *rect,
* may lie outside of the display.
* stride - The width of the full source image in bytes.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -936,7 +936,7 @@ void nx_redrawreq(NXWINDOW hwnd, FAR const struct nxgl_rect_s *rect);
* cb - Callbacks used to process window events
* arg - User provided value that will be returned with NX callbacks.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately. In the
* case of ERROR, NX will have deallocated the pre-allocated window.
*
include/nuttx/nx/nxfonts.h
+3 -3
View File
@@ -603,7 +603,7 @@ int nxf_convert_32bpp(FAR uint32_t *dest, uint16_t height,
* bpp - Bits per pixel
* maxglyphs - Maximum number of glyphs permitted in the cache
*
* Returned value:
* Returned Value:
* On success a non-NULL handle is returned that then may sequently be
* used with nxf_getglyph() to extract fonts from the font cache. NULL
* returned on any failure with the errno value set to indicate the nature
@@ -626,7 +626,7 @@ FCACHE nxf_cache_connect(enum nx_fontid_e fontid,
* Input Parameters:
* fhandle - A font cache handler previously returned by nxf_cache_connect();
*
* Returned value:
* Returned Value:
* None
*
****************************************************************************/
@@ -643,7 +643,7 @@ void nxf_cache_disconnect(FCACHE fhandle);
* Input Parameters:
* fhandle - A font cache handle previously returned by nxf_cache_connect();
*
* Returned value:
* Returned Value:
* Zero (OK) is returned if the metrics were
*
* Returned Value:
include/nuttx/nx/nxglib.h
+6 -6
View File
@@ -679,12 +679,12 @@ bool nxgl_colorcmp(const nxgl_mxpixel_t color1[CONFIG_NX_NPLANES],
* this case, 3 trapezoids will be returned, but traps[1] will be
* degenerate.
*
* Input parameters:
* Input Parameters:
* vector - A pointer to the vector described the line to be drawn.
* traps - A pointer to a array of trapezoids (size 3).
* rect - A pointer to a rectangle.
*
* Returned value:
* Returned Value:
* 0: Line successfully broken up into three trapezoids. Values in
* traps[0], traps[1], and traps[2] are valid.
* 1: Line successfully represented by one trapezoid. Value in traps[1]
@@ -708,13 +708,13 @@ int nxgl_splitline(FAR struct nxgl_vector_s *vector,
* circumference of the circle. These points may then be used by
* nx_drawcircle() or related APIs to draw a circle outline.
*
* Input parameters:
* Input Parameters:
* center - A pointer to the point that is the center of the circle
* radius - The radius of the circle in pixels.
* circle - A pointer the first entry in an array of 16 points where the
* circle points will be returned.
*
* Returned value:
* Returned Value:
* None
*
****************************************************************************/
@@ -730,13 +730,13 @@ void nxgl_circlepts(FAR const struct nxgl_point_s *center,
* Given a description of a a circle, return 8 trapezoids that can be
* used to fill the circle by nx_fillcircle() and other interfaces.
*
* Input parameters:
* Input Parameters:
* center - A pointer to the point that is the center of the circle
* radius - The radius of the circle in pixels.
* circle - A pointer the first entry in an array of 8 trapezoids where
* the circle description will be returned.
*
* Returned value:
* Returned Value:
* None
*
****************************************************************************/
include/nuttx/nx/nxmu.h
+4 -4
View File
@@ -495,7 +495,7 @@ extern "C"
* cb - Callbacks used to process window events
* arg - User provided value that will be returned with NX callbacks.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately. In the
* case of ERROR, NX will have deallocated the pre-allocated window.
*
@@ -515,7 +515,7 @@ int nxfe_constructwindow(NXHANDLE handle,
* Input Parameters:
* sem - the semaphore to be taken.
*
* Return:
* Returned Value:
* None
*
****************************************************************************/
@@ -533,7 +533,7 @@ void nxmu_semtake(sem_t *sem);
* msg - A pointer to the message to send
* msglen - The length of the message in bytes.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -553,7 +553,7 @@ int nxmu_sendserver(FAR struct nxfe_conn_s *conn,
* msg - A pointer to the message to send
* msglen - The length of the message in bytes.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
include/nuttx/nx/nxterm.h
+3 -3
View File
@@ -229,7 +229,7 @@ extern "C"
* nxtool_register() returns.
* minor - The device minor number
*
* Return:
* Returned Value:
* A non-NULL handle is returned on success.
*
****************************************************************************/
@@ -252,7 +252,7 @@ NXTERM nx_register(NXWINDOW hwnd, FAR struct nxterm_window_s *wndo,
* nxtool_register() returns.
* minor - The device minor number
*
* Return:
* Returned Value:
* A non-NULL handle is returned on success.
*
****************************************************************************/
@@ -277,7 +277,7 @@ NXTERM nxtk_register(NXTKWINDOW hfwnd, FAR struct nxterm_window_s *wndo,
* nxtool_register() returns.
* minor - The device minor number
*
* Return:
* Returned Value:
* A non-NULL handle is returned on success.
*
****************************************************************************/
include/nuttx/nx/nxtk.h
+29 -29
View File
@@ -125,7 +125,7 @@ extern "C"
* cb - Callbacks used to process window events
* arg - User provided value that will be returned with NXTK callbacks.
*
* Return:
* Returned Value:
* Success: A non-NULL handle used with subsequent NXTK window accesses
* Failure: NULL is returned and errno is set appropriately
*
@@ -143,7 +143,7 @@ NXTKWINDOW nxtk_openwindow(NXHANDLE handle,
* Input Parameters:
* hfwnd - The handle returned by nxtk_openwindow
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -176,7 +176,7 @@ int nxtk_closewindow(NXTKWINDOW hfwnd);
* arg - An argument that will accompany the block messages (This is arg2
* in the blocked callback).
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -194,7 +194,7 @@ int nxtk_block(NXTKWINDOW hfwnd, FAR void *arg);
* Input Parameters:
* hfwnd - The window handle returned by nxtk_openwindow.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -213,7 +213,7 @@ int nxtk_getposition(NXTKWINDOW hfwnd);
* hfwnd - The window handle returned by nxtk_openwindow
* pos - The new position of the client sub-window
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -232,7 +232,7 @@ int nxtk_setposition(NXTKWINDOW hfwnd, FAR const struct nxgl_point_s *pos);
* hfwnd - The window handle returned by nxtk_openwindow
* size - The new size of the client sub-window.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -246,11 +246,11 @@ int nxtk_setsize(NXTKWINDOW hfwnd, FAR const struct nxgl_size_s *size);
* Bring the window containing the specified client sub-window to the top
* of the display.
*
* Input parameters:
* Input Parameters:
* hfwnd - the window to be raised. This must have been previously created
* by nxtk_openwindow().
*
* Returned value:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -264,11 +264,11 @@ int nxtk_raise(NXTKWINDOW hfwnd);
* Lower the window containing the specified client sub-window to the
* bottom of the display.
*
* Input parameters:
* Input Parameters:
* hfwnd - the window to be lowered. This must have been previously created
* by nxtk_openwindow().
*
* Returned value:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -286,7 +286,7 @@ int nxtk_lower(NXTKWINDOW hfwnd);
* rect - The location within the client window to be filled
* color - The color to use in the fill
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -310,7 +310,7 @@ int nxtk_fillwindow(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect,
* dest - The location to copy the memory region
* deststride - The width, in bytes, of the dest memory
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -330,7 +330,7 @@ int nxtk_getwindow(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect,
* trap - The trapezoidal region to be filled
* color - The color to use in the fill
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -355,7 +355,7 @@ int nxtk_filltrapwindow(NXTKWINDOW hfwnd,
* caps - Draw a circular cap the ends of the line to support better
* line joins
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -377,7 +377,7 @@ int nxtk_drawlinewindow(NXTKWINDOW hfwnd, FAR struct nxgl_vector_s *vector,
* width - The width of the line
* color - The color to use to fill the line
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -399,7 +399,7 @@ int nxtk_drawcirclewindow(NXTKWINDOW hfwnd,
* radius - The radius of the circle in pixels.
* color - The color to use to fill the circle
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -423,7 +423,7 @@ int nxtk_fillcirclewindow(NXWINDOW hfwnd,
* offset - The offset to move the region. The rectangular region will be
* moved so that the origin is translated by this amount.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -449,7 +449,7 @@ int nxtk_movewindow(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect,
* origin may lie outside of the sub-window display.
* stride - The width of the full source image in pixels.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -471,7 +471,7 @@ int nxtk_bitmapwindow(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *dest,
* cb - Callbacks used to process toolbar events
* arg - User provided value that will be returned with toolbar callbacks.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -488,7 +488,7 @@ int nxtk_opentoolbar(NXTKWINDOW hfwnd, nxgl_coord_t height,
* Input Parameters:
* hfwnd - The handle returned by nxtk_openwindow
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -511,7 +511,7 @@ int nxtk_closetoolbar(NXTKWINDOW hfwnd);
* hfwnd - The handle returned by nxtk_openwindow
* bounds - User provided location in which to return the bounding box.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -529,7 +529,7 @@ int nxtk_toolbarbounds(NXTKWINDOW hfwnd, FAR struct nxgl_rect_s *bounds);
* rect - The location within the toolbar window to be filled
* color - The color to use in the fill
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -553,7 +553,7 @@ int nxtk_filltoolbar(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect,
* dest - The location to copy the memory region
* deststride - The width, in bytes, of the dest memory
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -573,7 +573,7 @@ int nxtk_gettoolbar(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect,
* trap - The trapezoidal region to be filled
* color - The color to use in the fill
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -599,7 +599,7 @@ int nxtk_filltraptoolbar(NXTKWINDOW hfwnd,
* caps - Draw a circular cap on the ends of the line to support better
* line joins
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -621,7 +621,7 @@ int nxtk_drawlinetoolbar(NXTKWINDOW hfwnd, FAR struct nxgl_vector_s *vector,
* width - The width of the line
* color - The color to use to fill the line
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -643,7 +643,7 @@ int nxtk_drawcircletoolbar(NXTKWINDOW hfwnd,
* radius - The radius of the circle in pixels.
* color - The color to use to fill the circle
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -668,7 +668,7 @@ int nxtk_fillcircletoolbar(NXWINDOW hfwnd,
* offset - The offset to move the region. The rectangular region will be
* moved so that the origin is translated by this amount.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
@@ -693,7 +693,7 @@ int nxtk_movetoolbar(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect,
* origin may lie outside of the sub-window display.
* stride - The width of the full source image in bytes.
*
* Return:
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
include/nuttx/power/battery_charger.h
+2 -2
View File
@@ -196,12 +196,12 @@ extern "C"
* Register a lower half battery driver with the common, upper-half
* battery driver.
*
* Input parameters:
* Input Parameters:
* devpath - The location in the pseudo-filesystem to create the driver.
* Recommended standard is "/dev/bat0", "/dev/bat1", etc.
* dev - An instance of the battery state structure .
*
* Returned value:
* Returned Value:
* Zero on success or a negated errno value on failure.
*
****************************************************************************/
include/nuttx/power/battery_gauge.h
+2 -2
View File
@@ -158,12 +158,12 @@ extern "C"
* Register a lower half battery driver with the common, upper-half
* battery driver.
*
* Input parameters:
* Input Parameters:
* devpath - The location in the pseudo-filesystem to create the driver.
* Recommended standard is "/dev/bat0", "/dev/bat1", etc.
* dev - An instance of the battery state structure .
*
* Returned value:
* Returned Value:
* Zero on success or a negated errno value on failure.
*
****************************************************************************/
include/nuttx/power/pm.h
+4 -4
View File
@@ -364,10 +364,10 @@ extern "C"
* *before* any other device drivers are initialized (since they may
* attempt to register with the power management subsystem).
*
* Input parameters:
* Input Parameters:
* None.
*
* Returned value:
* Returned Value:
* None.
*
****************************************************************************/
@@ -381,11 +381,11 @@ void pm_initialize(void);
* This function is called by a device driver in order to register to
* receive power management event callbacks.
*
* Input parameters:
* Input Parameters:
* callbacks - An instance of struct pm_callback_s providing the driver
* callback functions.
*
* Returned value:
* Returned Value:
* Zero (OK) on success; otherwise a negater errno value is returned.
*
****************************************************************************/
include/nuttx/sched.h
+10 -10
View File
@@ -823,12 +823,12 @@ FAR struct socketlist *sched_getsockets(void);
* The start hook is useful, for example, for setting up automatic
* configuration of C++ constructors.
*
* Inputs:
* Input Parameters:
* tcb - The new, unstarted task task that needs the start hook
* starthook - The pointer to the start hook function
* arg - The argument to pass to the start hook function.
*
* Return:
* Returned Value:
* None
*
********************************************************************************/
@@ -923,14 +923,14 @@ void sched_suspend_scheduler(FAR struct tcb_s *tcb);
* use by application logic. Applications should use the standard
* sched_getparam().
*
* Inputs:
* Input Parameters:
* pid - the task ID of the task. If pid is zero, the priority
* of the calling task is returned.
* param - A structure whose member sched_priority is the integer
* priority. The task's priority is copied to the sched_priority
* element of this structure.
*
* Return Value:
* Returned Value:
* 0 (OK) if successful, otherwise a negated errno value is returned to
* indicate the nature of the failure..
*
@@ -958,14 +958,14 @@ int nxsched_getparam (pid_t pid, FAR struct sched_param *param);
* use by application logic. Applications should use the standard
* sched_setparam().
*
* Inputs:
* Input Parameters:
* pid - the task ID of the task to reprioritize. If pid is zero, the
* priority of the calling task is changed.
* param - A structure whose member sched_priority is the integer priority.
* The range of valid priority numbers is from SCHED_PRIORITY_MIN
* through SCHED_PRIORITY_MAX.
*
* Return Value:
* Returned Value:
* 0 (OK) if successful, otherwise a negated errno value is returned to
* indicate the nature of the failure..
*
@@ -995,11 +995,11 @@ int nxsched_setparam(pid_t pid, FAR const struct sched_param *param);
* use by application logic. Applications should use the standard
* sched_getscheduler().
*
* Inputs:
* Input Parameters:
* pid - the task ID of the task to query. If pid is zero, the
* calling task is queried.
*
* Return Value:
* Returned Value:
* On success, sched_getscheduler() returns the policy for the task
* (either SCHED_FIFO or SCHED_RR). On error, a negated errno value
* returned:
@@ -1100,12 +1100,12 @@ int nxsched_getaffinity(pid_t pid, size_t cpusetsize, FAR cpu_set_t *mask);
* is not intended for use by application logic. Applications should
* use the standard sched_setparam().
*
* Inputs:
* Input Parameters:
* pid - The ID of thread whose affinity set will be modified.
* cpusetsize - Size of mask. MUST be sizeofcpu_set_t().
* mask - The location to return the thread's new affinity set.
*
* Return Value:
* Returned Value:
* Zero (OK) if successful. Otherwise, a negated errno value is returned:
*
* ESRCH The task whose ID is pid could not be found.
include/nuttx/semaphore.h
+13 -13
View File
@@ -159,7 +159,7 @@ extern "C"
* pshared - Process sharing (not used)
* value - Semaphore initialization value
*
* Return Value:
* Returned Value:
* This is an internal OS interface and should not be used by applications.
* It follows the NuttX internal error return policy: Zero (OK) is
* returned on success. A negated errno value is returned on failure.
@@ -185,7 +185,7 @@ int nxsem_init(FAR sem_t *sem, int pshared, unsigned int value);
* Parameters:
* sem - Semaphore to be destroyed.
*
* Return Value:
* Returned Value:
* This is an internal OS interface and should not be used by applications.
* It follows the NuttX internal error return policy: Zero (OK) is
* returned on success. A negated errno value is returned on failure.
@@ -211,7 +211,7 @@ int nxsem_destroy (FAR sem_t *sem);
* Parameters:
* sem - Semaphore descriptor.
*
* Return Value:
* Returned Value:
* This is an internal OS interface and should not be used by applications.
* It follows the NuttX internal error return policy: Zero (OK) is
* returned on success. A negated errno value is returned on failure.
@@ -235,7 +235,7 @@ int nxsem_wait(FAR sem_t *sem);
* Parameters:
* sem - the semaphore descriptor
*
* Return Value:
* Returned Value:
* This is an internal OS interface and should not be used by applications.
* It follows the NuttX internal error return policy: Zero (OK) is
* returned on success. A negated errno value is returned on failure.
@@ -276,7 +276,7 @@ int nxsem_trywait(FAR sem_t *sem);
* sem - Semaphore object
* abstime - The absolute time to wait until a timeout is declared.
*
* Return Value:
* Returned Value:
* This is an internal OS interface and should not be used by applications.
* It follows the NuttX internal error return policy: Zero (OK) is
* returned on success. A negated errno value is returned on failure.
@@ -313,7 +313,7 @@ int nxsem_timedwait(FAR sem_t *sem, FAR const struct timespec *abstime);
* posted. If ticks is zero, then this function is equivalent
* to sem_trywait().
*
* Return Value:
* Returned Value:
* This is an internal OS interface, not available to applications, and
* hence follows the NuttX internal error return policy: Zero (OK) is
* returned on success. A negated errno value is returned on failure.
@@ -342,7 +342,7 @@ int nxsem_tickwait(FAR sem_t *sem, systime_t start, uint32_t delay);
* Parameters:
* sem - Semaphore descriptor
*
* Return Value:
* Returned Value:
* This is an internal OS interface and should not be used by applications.
* It follows the NuttX internal error return policy: Zero (OK) is
* returned on success. A negated errno value is returned on failure.
@@ -373,7 +373,7 @@ int nxsem_post(FAR sem_t *sem);
* sem - Semaphore descriptor
* sval - Buffer by which the value is returned
*
* Return Value:
* Returned Value:
* This is an internal OS interface and should not be used by applications.
* It follows the NuttX internal error return policy: Zero (OK) is
* returned on success. A negated errno value is returned on failure.
@@ -395,7 +395,7 @@ int nxsem_getvalue(FAR sem_t *sem, FAR int *sval);
* sem - Semaphore descriptor to be reset
* count - The requested semaphore count
*
* Return Value:
* Returned Value:
* This is an internal OS interface, not available to applications, and
* hence follows the NuttX internal error return policy: Zero (OK) is
* returned on success. A negated errno value is returned on failure.
@@ -416,7 +416,7 @@ int nxsem_reset(FAR sem_t *sem, int16_t count);
* protocol - The user provided location in which to store the protocol
* value.
*
* Return Value:
* Returned Value:
* This is an internal OS interface and should not be used by applications.
* It follows the NuttX internal error return policy: Zero (OK) is
* returned on success. A negated errno value is returned on failure.
@@ -437,7 +437,7 @@ int nxsem_reset(FAR sem_t *sem, int16_t count);
* protocol - The user provided location in which to store the protocol
* value.
*
* Return Value:
* Returned Value:
* This function is exposed as a non-standard application interface. It
* returns zero (OK) if successful. Otherwise, -1 (ERROR) is returned and
* the errno value is set appropriately.
@@ -476,7 +476,7 @@ int sem_getprotocol(FAR sem_t *sem, FAR int *protocol);
* modified
* protocol - The new protocol to use
*
* Return Value:
* Returned Value:
* This is an internal OS interface and should not be used by applications.
* It follows the NuttX internal error return policy: Zero (OK) is
* returned on success. A negated errno value is returned on failure.
@@ -515,7 +515,7 @@ int nxsem_setprotocol(FAR sem_t *sem, int protocol);
* modified
* protocol - The new protocol to use
*
* Return Value:
* Returned Value:
* This function is exposed as a non-standard application interface. It
* returns zero (OK) if successful. Otherwise, -1 (ERROR) is returned and
* the errno value is set appropriately.
include/nuttx/signal.h
+4 -4
View File
@@ -127,7 +127,7 @@ struct timespec; /* Forward reference */
* set - Location of the new signal mask
* oset - Location to store the old signal mask
*
* Return Value:
* Returned Value:
* This is an internal OS interface and should not be used by applications.
* It follows the NuttX internal error return policy: Zero (OK) is
* returned on success. A negated errno value is returned on failure.
@@ -160,7 +160,7 @@ int nxsig_procmask(int how, FAR const sigset_t *set, FAR sigset_t *oset);
* signo - Signal number
* value - Value to pass to task with signal
*
* Return Value:
* Returned Value:
* This is an internal OS interface and should not be used by applications.
* It follows the NuttX internal error return policy: Zero (OK) is
* returned on success. A negated errno value is returned on failure.
@@ -232,7 +232,7 @@ int nxsig_kill(pid_t pid, int signo);
* set - The pending signal set
* info - The returned value
*
* Return Value:
* Returned Value:
* This is an internal OS interface and should not be used by applications.
* It follows the NuttX internal error return policy: Zero (OK) is
* returned on success. A negated errno value is returned on failure.
@@ -270,7 +270,7 @@ int nxsig_kill(pid_t pid, int signo);
* info - The returned value (may be NULL).
* timeout - The amount of time to wait (may be NULL)
*
* Return Value:
* Returned Value:
* This is an internal OS interface and should not be used by applications.
* It follows the NuttX internal error return policy: Zero (OK) is
* returned on success. A negated errno value is returned on failure.

Some files were not shown because too many files have changed in this diff Show More