123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223 |
- /****************************************************************************
- * include/nuttx/progmem.h
- *
- * Copyright(C) 2011 Uros Platise. All rights reserved.
- * Author: Uros Platise <uros.platise@isotel.eu>
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- * 3. Neither the name NuttX nor the names of its contributors may be
- * used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
- * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES(INCLUDING,
- * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
- * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
- * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
- * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- *
- ****************************************************************************/
- #ifndef __INCLUDE_NUTTX_PROGMEM_H
- #define __INCLUDE_NUTTX_PROGMEM_H
- /****************************************************************************
- * Included Files
- ****************************************************************************/
- #include <nuttx/config.h>
- #include <sys/types.h>
- #include <stdbool.h>
- #ifdef CONFIG_ARCH_HAVE_PROGMEM
- /****************************************************************************
- * Pre-processor Definitions
- ****************************************************************************/
- #undef EXTERN
- #if defined(__cplusplus)
- #define EXTERN extern "C"
- extern "C"
- {
- #else
- #define EXTERN extern
- #endif
- /****************************************************************************
- * Public Functions
- ****************************************************************************/
- /****************************************************************************
- * Name: up_progmem_neraseblocks
- *
- * Description:
- * Return number of erase blocks
- *
- ****************************************************************************/
- size_t up_progmem_neraseblocks(void);
- /****************************************************************************
- * Name: up_progmem_isuniform
- *
- * Description:
- * Is program memory uniform or erase page and read/write page size differs?
- *
- ****************************************************************************/
- bool up_progmem_isuniform(void);
- /****************************************************************************
- * Name: up_progmem_pagesize
- *
- * Description:
- * Return read/write page size
- *
- ****************************************************************************/
- size_t up_progmem_pagesize(size_t page);
- /****************************************************************************
- * Name: up_progmem_erasesize
- *
- * Description:
- * Return erase block size. Must be a multiple of the read/write page size.
- *
- ****************************************************************************/
- size_t up_progmem_erasesize(size_t block);
- /****************************************************************************
- * Name: up_progmem_getpage
- *
- * Description:
- * Address to read/write page conversion
- *
- * Input Parameters:
- * addr - Address with or without flash offset (absolute or aligned to page0)
- *
- * Returned Value:
- * Page or negative value on error. The following errors are reported
- * (errno is not set!):
- *
- * -EFAULT: On invalid address
- *
- ****************************************************************************/
- ssize_t up_progmem_getpage(size_t addr);
- /****************************************************************************
- * Name: up_progmem_getaddress
- *
- * Description:
- * Read/write page to address conversion
- *
- * Input Parameters:
- * page - page index
- *
- * Returned Value:
- * Base address of given page, SIZE_MAX if page index is not valid.
- *
- ****************************************************************************/
- size_t up_progmem_getaddress(size_t page);
- /****************************************************************************
- * Name: up_progmem_eraseblock
- *
- * Description:
- * Erase selected erase block.
- *
- * Input Parameters:
- * block - The erase block index to be erased.
- *
- * Returned Value:
- * block size or negative value on error. The following errors are reported
- * (errno is not set!):
- *
- * -EFAULT: On invalid page
- * -EIO: On unsuccessful erase
- * -EROFS: On access to write protected area
- * -EACCES: Insufficient permissions (read/write protected)
- * -EPERM: If operation is not permitted due to some other constraints
- * (i.e. some internal block is not running etc.)
- *
- ****************************************************************************/
- ssize_t up_progmem_eraseblock(size_t block);
- /****************************************************************************
- * Name: up_progmem_ispageerased
- *
- * Description:
- * Checks whether erase page is erased
- *
- * Input Parameters:
- * page - The page index to be checked.
- *
- * Returned Value:
- * Returns number of bytes NOT erased or negative value on error. If it
- * returns zero then complete page is erased.
- *
- * The following errors are reported:
- * -EFAULT: On invalid page
- *
- ****************************************************************************/
- ssize_t up_progmem_ispageerased(size_t page);
- /****************************************************************************
- * Name: up_progmem_write
- *
- * Description:
- * Program data at given address
- *
- * Note: this function is not limited to single page and nor it requires
- * the address be aligned inside the page boundaries.
- *
- * Input Parameters:
- * addr - Address with or without flash offset (absolute or aligned to page0)
- * buf - Pointer to buffer
- * count - Number of bytes to write
- *
- * Returned Value:
- * Bytes written or negative value on error. The following errors are
- * reported (errno is not set!)
- *
- * EINVAL: If count is not aligned with the flash boundaries (i.e.
- * some MCU's require per half-word or even word access)
- * EFAULT: On invalid address
- * EIO: On unsuccessful write
- * EROFS: On access to write protected area
- * EACCES: Insufficient permissions (read/write protected)
- * EPERM: If operation is not permitted due to some other constraints
- * (i.e. some internal block is not running etc.)
- *
- ****************************************************************************/
- ssize_t up_progmem_write(size_t addr, FAR const void *buf, size_t count);
- #undef EXTERN
- #if defined(__cplusplus)
- }
- #endif
- #endif /* CONFIG_ARCH_HAVE_PROGMEM */
- #endif /* __INCLUDE_NUTTX_PROGMEM_H */
|