sergiotarxz/nuttx
sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

progmem.h: Clean-up a few comments

Browse Source
This commit is contained in:
Gregory Nutt 2015-11-11 14:30:06 -06:00
parent e62673241d
commit 7fe6200b0f
3 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
arch

@ -1 +1 @@
Subproject commit 352e3775a07839c6747bd29c151fa61dc938b62a Subproject commit 20a3b8c8cedd8f5d147dcf01599059c8678b123c

2
configs

@ -1 +1 @@
Subproject commit d5c2d3699b337a11ef0e5f204537873e719a97ae Subproject commit 758aa6d23647d98fb1a6064175a8abd6c9cc28b2

26
include/nuttx/progmem.h
View File

@ -99,7 +99,7 @@ size_t up_progmem_pagesize(size_t page);
* Address to page conversion * Address to page conversion
* *
* Input Parameters: * Input Parameters:
* addr - Address with of without flash offset (absolute or aligned to page0) * addr - Address with or without flash offset (absolute or aligned to page0)
* *
* Returned Value: * Returned Value:
* Page or negative value on error. The following errors are reported * Page or negative value on error. The following errors are reported
@ -141,11 +141,11 @@ size_t up_progmem_getaddress(size_t page);
* (errno is not set!): * (errno is not set!):
* *
* EFAULT: On invalid page * EFAULT: On invalid page
* EIO: On unsuccessful erase * EIO: On unsuccessful erase
* EROFS: On access to write protected area * EROFS: On access to write protected area
* EACCES: Insufficient permissions (read/write protected) * EACCES: Insufficient permissions (read/write protected)
* EPERM: If operation is not permitted due to some other constraints * EPERM: If operation is not permitted due to some other constraints
* (i.e. some internal block is not running etc.) * (i.e. some internal block is not running etc.)
* *
****************************************************************************/ ****************************************************************************/
@ -183,24 +183,24 @@ ssize_t up_progmem_ispageerased(size_t page);
* Input Parameters: * Input Parameters:
* addr - Address with or without flash offset (absolute or aligned to page0) * addr - Address with or without flash offset (absolute or aligned to page0)
* buf - Pointer to buffer * buf - Pointer to buffer
* count - Number of bytes to write * * count - Number of bytes to write
* *
* Returned Value: * Returned Value:
* Bytes written or negative value on error. The following errors are * Bytes written or negative value on error. The following errors are
* reported (errno is not set!) * reported (errno is not set!)
* *
* EINVAL: if count is not aligned with the flash boundaries (i.e. * EINVAL: If count is not aligned with the flash boundaries (i.e.
* some MCU's require per half-word or even word access) * some MCU's require per half-word or even word access)
* EFAULT: On invalid address * EFAULT: On invalid address
* EIO: On unsuccessful write * EIO: On unsuccessful write
* EROFS: On access to write protected area * EROFS: On access to write protected area
* EACCES: Insufficient permissions (read/write protected) * EACCES: Insufficient permissions (read/write protected)
* EPERM: If operation is not permitted due to some other constraints * EPERM: If operation is not permitted due to some other constraints
* (i.e. some internal block is not running etc.) * (i.e. some internal block is not running etc.)
* *
****************************************************************************/ ****************************************************************************/
ssize_t up_progmem_write(size_t addr, const void *buf, size_t count); ssize_t up_progmem_write(size_t addr, FAR const void *buf, size_t count);
#undef EXTERN #undef EXTERN
#if defined(__cplusplus) #if defined(__cplusplus)