Macros
#define	PROGMEM_FAR __attribute__((__section__(".progmemx.data")))

#define	PROGMEM __attribute__((__progmem__))

#define	PSTR(str) ({ static const PROGMEM char c[] = (str); &c[0]; })

#define	PSTR_FAR(str) ({ static const PROGMEM_FAR char c[] = (str); pgm_get_far_address(c[0]); })

#define	pgm_read_byte_near(__addr) __LPM ((uint16_t)(__addr))

#define	pgm_read_word_near(__addr) __LPM_word ((uint16_t)(__addr))

#define	pgm_read_dword_near(__addr) __LPM_dword ((uint16_t)(__addr))

#define	pgm_read_qword_near(__addr) __LPM_qword ((uint16_t)(__addr))

#define	pgm_read_float_near(addr) pgm_read_float (addr)

#define	pgm_read_ptr_near(__addr) ((void*) __LPM_word ((uint16_t)(__addr)))

#define	pgm_read_byte_far(__addr) __ELPM (__addr)

#define	pgm_read_word_far(__addr) __ELPM_word (__addr)

#define	pgm_read_dword_far(__addr) __ELPM_dword (__addr)

#define	pgm_read_qword_far(__addr) __ELPM_qword (__addr)

#define	pgm_read_ptr_far(__addr) ((void*) __ELPM_word (__addr))

#define	pgm_read_byte(__addr) pgm_read_byte_near(__addr)

#define	pgm_read_word(__addr) pgm_read_word_near(__addr)

#define	pgm_read_dword(__addr) pgm_read_dword_near(__addr)

#define	pgm_read_qword(__addr) pgm_read_qword_near(__addr)

#define	pgm_read_ptr(__addr) pgm_read_ptr_near(__addr)

#define	pgm_get_far_address(var)

Functions
static char	pgm_read_char (const char *__addr)

static unsigned char	pgm_read_unsigned_char (const unsigned char *__addr)

static signed char	pgm_read_signed_char (const signed char *__addr)

static uint8_t	pgm_read_u8 (const uint8_t *__addr)

static int8_t	pgm_read_i8 (const int8_t *__addr)

static short	pgm_read_short (const short *__addr)

static unsigned short	pgm_read_unsigned_short (const unsigned short *__addr)

static uint16_t	pgm_read_u16 (const uint16_t *__addr)

static int16_t	pgm_read_i16 (const int16_t *__addr)

static int	pgm_read_int (const int *__addr)

static signed	pgm_read_signed (const signed *__addr)

static unsigned	pgm_read_unsigned (const unsigned *__addr)

static signed int	pgm_read_signed_int (const signed int *__addr)

static unsigned int	pgm_read_unsigned_int (const unsigned int *__addr)

static __int24	pgm_read_i24 (const __int24 *__addr)

static __uint24	pgm_read_u24 (const __uint24 *__addr)

static uint32_t	pgm_read_u32 (const uint32_t *__addr)

static int32_t	pgm_read_i32 (const int32_t *__addr)

static long	pgm_read_long (const long *__addr)

static unsigned long	pgm_read_unsigned_long (const unsigned long *__addr)

static long long	pgm_read_long_long (const long long *__addr)

static unsigned long long	pgm_read_unsigned_long_long (const unsigned long long *__addr)

static uint64_t	pgm_read_u64 (const uint64_t *__addr)

static int64_t	pgm_read_i64 (const int64_t *__addr)

static float	pgm_read_float (const float *__addr)

static double	pgm_read_double (const double *__addr)

static long double	pgm_read_long_double (const long double *__addr)

static char	pgm_read_char_far (uint_farptr_t __addr)

static unsigned char	pgm_read_unsigned_char_far (uint_farptr_t __addr)

static signed char	pgm_read_signed_char_far (uint_farptr_t __addr)

static uint8_t	pgm_read_u8_far (uint_farptr_t __addr)

static int8_t	pgm_read_i8_far (uint_farptr_t __addr)

static short	pgm_read_short_far (uint_farptr_t __addr)

static unsigned short	pgm_read_unsigned_short_far (uint_farptr_t __addr)

static uint16_t	pgm_read_u16_far (uint_farptr_t __addr)

static int16_t	pgm_read_i16_far (uint_farptr_t __addr)

static int	pgm_read_int_far (uint_farptr_t __addr)

static unsigned	pgm_read_unsigned_far (uint_farptr_t __addr)

static unsigned int	pgm_read_unsigned_int_far (uint_farptr_t __addr)

static signed	pgm_read_signed_far (uint_farptr_t __addr)

static signed int	pgm_read_signed_int_far (uint_farptr_t __addr)

static long	pgm_read_long_far (uint_farptr_t __addr)

static unsigned long	pgm_read_unsigned_long_far (uint_farptr_t __addr)

static __int24	pgm_read_i24_far (uint_farptr_t __addr)

static __uint24	pgm_read_u24_far (uint_farptr_t __addr)

static uint32_t	pgm_read_u32_far (uint_farptr_t __addr)

static int32_t	pgm_read_i32_far (uint_farptr_t __addr)

static long long	pgm_read_long_long_far (uint_farptr_t __addr)

static unsigned long long	pgm_read_unsigned_long_long_far (uint_farptr_t __addr)

static uint64_t	pgm_read_u64_far (uint_farptr_t __addr)

static int64_t	pgm_read_i64_far (uint_farptr_t __addr)

static float	pgm_read_float_far (uint_farptr_t __addr)

static double	pgm_read_double_far (uint_farptr_t __addr)

static long double	pgm_read_long_double_far (uint_farptr_t __addr)

const void *	memchr_P (const void *, int __val, size_t __len)

int	memcmp_P (const void , const void , size_t)

void *	memccpy_P (void , const void , int __val, size_t)

void *	memcpy_P (void , const void , size_t)

void *	memmem_P (const void , size_t, const void , size_t)

const void *	memrchr_P (const void *, int __val, size_t __len)

char *	strcat_P (char , const char )

const char *	strchr_P (const char *, int __val)

const char *	strchrnul_P (const char *, int __val)

int	strcmp_P (const char , const char )

char *	strcpy_P (char , const char )

int	strcasecmp_P (const char , const char )

char *	strcasestr_P (const char , const char )

size_t	strcspn_P (const char __s, const char __reject)

size_t	strlcat_P (char , const char , size_t)

size_t	strlcpy_P (char , const char , size_t)

size_t	strnlen_P (const char *, size_t)

int	strncmp_P (const char , const char , size_t)

int	strncasecmp_P (const char , const char , size_t)

char *	strncat_P (char , const char , size_t)

char *	strncpy_P (char , const char , size_t)

char *	strpbrk_P (const char __s, const char __accept)

const char *	strrchr_P (const char *, int __val)

char *	strsep_P (char *__sp, const char __delim)

size_t	strspn_P (const char __s, const char __accept)

char *	strstr_P (const char , const char )

char *	strtok_P (char __s, const char __delim)

char *	strtok_rP (char __s, const char __delim, char **__last)

size_t	strlen_PF (uint_farptr_t src)

size_t	strnlen_PF (uint_farptr_t src, size_t len)

void *	memcpy_PF (void *dest, uint_farptr_t src, size_t len)

char *	strcpy_PF (char *dest, uint_farptr_t src)

char *	strncpy_PF (char *dest, uint_farptr_t src, size_t len)

char *	strcat_PF (char *dest, uint_farptr_t src)

size_t	strlcat_PF (char *dst, uint_farptr_t src, size_t siz)

char *	strncat_PF (char *dest, uint_farptr_t src, size_t len)

int	strcmp_PF (const char *s1, uint_farptr_t s2)

int	strncmp_PF (const char *s1, uint_farptr_t s2, size_t n)

int	strcasecmp_PF (const char *s1, uint_farptr_t s2)

int	strncasecmp_PF (const char *s1, uint_farptr_t s2, size_t n)

uint_farptr_t	strchr_PF (uint_farptr_t, int __val)

char *	strstr_PF (const char *s1, uint_farptr_t s2)

size_t	strlcpy_PF (char *dst, uint_farptr_t src, size_t siz)

int	memcmp_PF (const void *, uint_farptr_t, size_t)

static size_t	strlen_P (const char *s)

template<typename T >
T	pgm_read< T > (const T *addr)

template<typename T >
T	pgm_read_far< T > (uint_farptr_t addr)

Detailed Description

#include <avr/io.h>

#include <avr/pgmspace.h>

io.h

pgmspace.h

The functions in this module provide interfaces for a program to access data stored in program space (flash memory) of the device.

Note: These functions are an attempt to provide some compatibility with header files that come with IAR C, to make porting applications between different compilers easier. This is not 100% compatibility though (GCC does not have full support for multiple address spaces yet).; If you are working with strings which are completely based in RAM, use the standard string functions described in <string.h>: Strings.; If possible, put your constant tables in the lower 64 KB and use pgm_read_byte_near() or pgm_read_word_near() instead of pgm_read_byte_far() or pgm_read_word_far() since it is more efficient that way, and you can still use the upper 64K for executable code. All functions that are suffixed with a _P require their arguments to be in the lower 64 KB of the flash ROM, as they do not use ELPM instructions. This is normally not a big concern as the linker setup arranges any program space constants declared using the macros from this header file so they are placed right after the interrupt vectors, and in front of any executable code. However, it can become a problem if there are too many of these constants, or for bootloaders on devices with more than 64 KB of ROM. All these functions will not work in that situation.; For Xmega devices, make sure the NVM controller command register (NVM.CMD or NVM_CMD) is set to 0x00 (NOP) before using any of these functions.

Macro Definition Documentation

◆ pgm_get_far_address

#define pgm_get_far_address ( var )

Value:

(({                                      \
    uint_farptr_t __tmp;                              \
                                                      \
    __asm__ __volatile__ (                            \
        "ldi    %A0, lo8(%1)"           "\n\t"        \
        "ldi    %B0, hi8(%1)"           "\n\t"        \
        "ldi    %C0, hh8(%1)"           "\n\t"        \
        "clr    %D0"                                  \
        :   "=d" (__tmp)                              \
        :   "i"  (&(var))                             \
    );                                                \
    __tmp;                                            \
}))

This macro evaluates to a uint_farptr_t 32-bit "far" pointer (only 24 bits used) to data even beyond the 64 KiB limit for the 16-bit ordinary pointer. It is similar to the '&' operator, with some limitations. Example:

#include <avr/pgmspace.h>
 
// Section .progmemx.data is located after all the code sections.
__attribute__((section(".progmemx.data")))
const int data[] = { 2, 3, 5, 7, 9, 11 };
 
int get_data (uint8_t idx)
{
    uint_farptr_t pdata = pgm_get_far_address (data[0]);
    return pgm_read_int_far (pdata + idx * sizeof(int));
}

Comments:

The overhead is minimal and it's mainly due to the 32-bit size operation.
24 bit sizes guarantees the code compatibility for use in future devices.
var has to be resolved at link-time as an existing symbol, i.e. a simple variable name, an array name, or an array or structure element provided the offset is known at compile-time, and var is located in static storage, etc.
The returned value is the symbol's VMA (virtual memory address) determined by the linker and falls in the corresponding memory region. The AVR Harvard architecture requires non-overlapping VMA areas for the multiple memory regions in the processor: Flash ROM, RAM, and EEPROM. Typical offset for these are 0x0, 0x800xx0, and 0x810000 respectively, derived from the linker script used and linker options.

◆ pgm_read_byte

#define pgm_read_byte ( __addr ) pgm_read_byte_near(__addr)

Read a byte from the program space with a 16-bit (near) nyte-address.

◆ pgm_read_byte_far

#define pgm_read_byte_far ( __addr ) __ELPM (__addr)

Read a byte from the program space with a 32-bit (far) byte-address.

◆ pgm_read_byte_near

#define pgm_read_byte_near ( __addr ) __LPM ((uint16_t)(__addr))

Read a byte from the program space with a 16-bit (near) byte-address.

◆ pgm_read_dword

#define pgm_read_dword ( __addr ) pgm_read_dword_near(__addr)

Read a double word from the program space with a 16-bit (near) byte-address.

◆ pgm_read_dword_far

#define pgm_read_dword_far ( __addr ) __ELPM_dword (__addr)

Read a double word from the program space with a 32-bit (far) byte-address.

◆ pgm_read_dword_near

#define pgm_read_dword_near ( __addr ) __LPM_dword ((uint16_t)(__addr))

Read a double word from the program space with a 16-bit (near) byte-address.

◆ pgm_read_float_near

#define pgm_read_float_near ( addr ) pgm_read_float (addr)

Read a float from the program space with a 16-bit (near) byte-address.

◆ pgm_read_ptr

#define pgm_read_ptr ( __addr ) pgm_read_ptr_near(__addr)

Read a pointer from the program space with a 16-bit (near) byte-address.

◆ pgm_read_ptr_far

#define pgm_read_ptr_far ( __addr ) ((void*) __ELPM_word (__addr))

Read a pointer from the program space with a 32-bit (far) byte-address.

◆ pgm_read_ptr_near

#define pgm_read_ptr_near ( __addr ) ((void*) __LPM_word ((uint16_t)(__addr)))

Read a pointer from the program space with a 16-bit (near) byte-address.

◆ pgm_read_qword

#define pgm_read_qword ( __addr ) pgm_read_qword_near(__addr)

Read a quad-word from the program space with a 16-bit (near) byte-address.

◆ pgm_read_qword_far

#define pgm_read_qword_far ( __addr ) __ELPM_qword (__addr)

Read a quad-word from the program space with a 32-bit (far) byte-address.

◆ pgm_read_qword_near

#define pgm_read_qword_near ( __addr ) __LPM_qword ((uint16_t)(__addr))

Read a quad-word from the program space with a 16-bit (near) byte-address.

◆ pgm_read_word

#define pgm_read_word ( __addr ) pgm_read_word_near(__addr)

Read a word from the program space with a 16-bit (near) byte-address.

◆ pgm_read_word_far

#define pgm_read_word_far ( __addr ) __ELPM_word (__addr)

Read a word from the program space with a 32-bit (far) byte-address.

◆ pgm_read_word_near

#define pgm_read_word_near ( __addr ) __LPM_word ((uint16_t)(__addr))

Read a word from the program space with a 16-bit (near) byte-address.

◆ PROGMEM

#define PROGMEM __attribute__((__progmem__))

Attribute to use in order to declare an object being located in flash ROM.

◆ PROGMEM_FAR

#define PROGMEM_FAR __attribute__((__section__(".progmemx.data")))

Attribute to use in order to declare an object being located in far flash ROM. This is similar to PROGMEM, except that it puts the static storage object in section .progmemx.data. In order to access the object, the pgm_read_*_far and _PF functions declare in this header can be used. In order to get its address, see pgm_get_far_address().

It only makes sense to put read-only objects in this section, though the compiler does not diagnose when this is not the case.

◆ PSTR

#define PSTR ( str ) ({ static const PROGMEM char c[] = (str); &c[0]; })

Used to declare a static pointer to a string in program space.

◆ PSTR_FAR

#define PSTR_FAR ( str ) ({ static const PROGMEM_FAR char c[] = (str); pgm_get_far_address(c[0]); })

Used to define a string literal in far program space, and to return its address of type uint_farptr_t.

Function Documentation

◆ memccpy_P()

void * memccpy_P	(	void *	dest,
		const void *	src,
		int	val,
		size_t	len
	)

This function is similar to memccpy() except that src is pointer to a string in program space.

◆ memchr_P()

const void * memchr_P	(	const void *	s,
		int	val,
		size_t	len
	)

Scan flash memory for a character.

The memchr_P() function scans the first len bytes of the flash memory area pointed to by s for the character val. The first byte to match val (interpreted as an unsigned character) stops the operation.

Returns: The memchr_P() function returns a pointer to the matching byte or NULL if the character does not occur in the given memory area.

◆ memcmp_P()

int memcmp_P	(	const void *	s1,
		const void *	s2,
		size_t	len
	)

Compare memory areas.

The memcmp_P() function compares the first len bytes of the memory areas s1 and flash s2. The comparision is performed using unsigned char operations.

Returns: The memcmp_P() function returns an integer less than, equal to, or greater than zero if the first len bytes of s1 is found, respectively, to be less than, to match, or be greater than the first len bytes of s2.

◆ memcmp_PF()

int memcmp_PF	(	const void *	s1,
		uint_farptr_t	s2,
		size_t	len
	)

Compare memory areas.

The memcmp_PF() function compares the first len bytes of the memory areas s1 and flash s2. The comparision is performed using unsigned char operations. It is an equivalent of memcmp_P() function, except that it is capable working on all FLASH including the exteded area above 64kB.

Returns: The memcmp_PF() function returns an integer less than, equal to, or greater than zero if the first len bytes of s1 is found, respectively, to be less than, to match, or be greater than the first len bytes of s2.

◆ memcpy_P()

void * memcpy_P	(	void *	dest,
		const void *	src,
		size_t	n
	)

The memcpy_P() function is similar to memcpy(), except the src string resides in program space.

Returns: The memcpy_P() function returns a pointer to dest.

◆ memcpy_PF()

void * memcpy_PF	(	void *	dest,
		uint_farptr_t	src,
		size_t	n
	)

Copy a memory block from flash to SRAM.

The memcpy_PF() function is similar to memcpy(), except the data is copied from the program space and is addressed using a far pointer.

Parameters

dest	A pointer to the destination buffer
src	A far pointer to the origin of data in flash memory
n	The number of bytes to be copied

Returns: The memcpy_PF() function returns a pointer to dst. The contents of RAMPZ SFR are undefined when the function returns.

◆ memmem_P()

void * memmem_P	(	const void *	s1,
		size_t	len1,
		const void *	s2,
		size_t	len2
	)

The memmem_P() function is similar to memmem() except that s2 is pointer to a string in program space.

◆ memrchr_P()

const void memrchr_P	(	const void *	src,
		int	val,
		size_t	len
	)

The memrchr_P() function is like the memchr_P() function, except that it searches backwards from the end of the len bytes pointed to by src instead of forwards from the front. (Glibc, GNU extension.)

Returns: The memrchr_P() function returns a pointer to the matching byte or NULL if the character does not occur in the given memory area.

◆ pgm_read< T >()

template<typename T >

T pgm_read< T > ( const T * addr )

Read an object of type T from program memory address addr and return it. This template is only available when macro __pgm_read_template__ is defined.

◆ pgm_read_char()

char pgm_read_char ( const char * __addr )

inlinestatic

Read a char from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_char_far()

char pgm_read_char_far ( uint_farptr_t __addr )

inlinestatic

Read a char from far byte-address __addr. The address is in the program memory.

◆ pgm_read_double()

double pgm_read_double ( const double * __addr )

inlinestatic

Read a double from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_double_far()

double pgm_read_double_far ( uint_farptr_t __addr )

inlinestatic

Read a double from far byte-address __addr. The address is in the program memory.

◆ pgm_read_far< T >()

template<typename T >

T pgm_read_far< T > ( uint_farptr_t addr )

Read an object of type T from program memory address addr and return it. This template is only available when macro __pgm_read_template__ is defined.

◆ pgm_read_float()

float pgm_read_float ( const float * __addr )

inlinestatic

Read a float from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_float_far()

float pgm_read_float_far ( uint_farptr_t __addr )

inlinestatic

Read a float from far byte-address __addr. The address is in the program memory.

◆ pgm_read_i16()

int16_t pgm_read_i16 ( const int16_t * __addr )

inlinestatic

Read an int16_t from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_i16_far()

int16_t pgm_read_i16_far ( uint_farptr_t __addr )

inlinestatic

Read an int16_t from far byte-address __addr. The address is in the program memory.

◆ pgm_read_i24()

__int24 pgm_read_i24 ( const __int24 * __addr )

inlinestatic

Read an __int24 from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_i24_far()

__int24 pgm_read_i24_far ( uint_farptr_t __addr )

inlinestatic

Read an __int24 from far byte-address __addr. The address is in the program memory.

◆ pgm_read_i32()

int32_t pgm_read_i32 ( const int32_t * __addr )

inlinestatic

Read an int32_t from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_i32_far()

int32_t pgm_read_i32_far ( uint_farptr_t __addr )

inlinestatic

Read an int32_t from far byte-address __addr. The address is in the program memory.

◆ pgm_read_i64()

int64_t pgm_read_i64 ( const int64_t * __addr )

inlinestatic

Read an int64_t from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_i64_far()

int64_t pgm_read_i64_far ( uint_farptr_t __addr )

inlinestatic

Read an int64_t from far byte-address __addr. The address is in the program memory.

◆ pgm_read_i8()

int8_t pgm_read_i8 ( const int8_t * __addr )

inlinestatic

Read an int8_t from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_i8_far()

int8_t pgm_read_i8_far ( uint_farptr_t __addr )

inlinestatic

Read an int8_t from far byte-address __addr. The address is in the program memory.

◆ pgm_read_int()

int pgm_read_int ( const int * __addr )

inlinestatic

Read an int from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_int_far()

int pgm_read_int_far ( uint_farptr_t __addr )

inlinestatic

Read an int from far byte-address __addr. The address is in the program memory.

◆ pgm_read_long()

long pgm_read_long ( const long * __addr )

inlinestatic

Read a long from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_long_double()

long double pgm_read_long_double ( const long double * __addr )

inlinestatic

Read a long double from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_long_double_far()

long double pgm_read_long_double_far ( uint_farptr_t __addr )

inlinestatic

Read a long double from far byte-address __addr. The address is in the program memory.

◆ pgm_read_long_far()

long pgm_read_long_far ( uint_farptr_t __addr )

inlinestatic

Read a long from far byte-address __addr. The address is in the program memory.

◆ pgm_read_long_long()

long long pgm_read_long_long ( const long long * __addr )

inlinestatic

Read a long long from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_long_long_far()

long long pgm_read_long_long_far ( uint_farptr_t __addr )

inlinestatic

Read a long long from far byte-address __addr. The address is in the program memory.

◆ pgm_read_short()

short pgm_read_short ( const short * __addr )

inlinestatic

Read a short from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_short_far()

short pgm_read_short_far ( uint_farptr_t __addr )

inlinestatic

Read a short from far byte-address __addr. The address is in the program memory.

◆ pgm_read_signed()

signed pgm_read_signed ( const signed * __addr )

inlinestatic

Read a signed from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_signed_char()

signed char pgm_read_signed_char ( const signed char * __addr )

inlinestatic

Read a signed char from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_signed_char_far()

signed char pgm_read_signed_char_far ( uint_farptr_t __addr )

inlinestatic

Read a signed char from far byte-address __addr. The address is in the program memory.

◆ pgm_read_signed_far()

signed pgm_read_signed_far ( uint_farptr_t __addr )

inlinestatic

Read a signed from far byte-address __addr. The address is in the program memory.

◆ pgm_read_signed_int()

signed int pgm_read_signed_int ( const signed int * __addr )

inlinestatic

Read a signed int from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_signed_int_far()

signed int pgm_read_signed_int_far ( uint_farptr_t __addr )

inlinestatic

Read a signed int from far byte-address __addr. The address is in the program memory.

◆ pgm_read_u16()

uint16_t pgm_read_u16 ( const uint16_t * __addr )

inlinestatic

Read an uint16_t from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_u16_far()

uint16_t pgm_read_u16_far ( uint_farptr_t __addr )

inlinestatic

Read an uint16_t from far byte-address __addr. The address is in the program memory.

◆ pgm_read_u24()

__uint24 pgm_read_u24 ( const __uint24 * __addr )

inlinestatic

Read an __uint24 from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_u24_far()

__uint24 pgm_read_u24_far ( uint_farptr_t __addr )

inlinestatic

Read an __uint24 from far byte-address __addr. The address is in the program memory.

◆ pgm_read_u32()

uint32_t pgm_read_u32 ( const uint32_t * __addr )

inlinestatic

Read an uint32_t from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_u32_far()

uint32_t pgm_read_u32_far ( uint_farptr_t __addr )

inlinestatic

Read an uint32_t from far byte-address __addr. The address is in the program memory.

◆ pgm_read_u64()

uint64_t pgm_read_u64 ( const uint64_t * __addr )

inlinestatic

Read an uint64_t from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_u64_far()

uint64_t pgm_read_u64_far ( uint_farptr_t __addr )

inlinestatic

Read an uint64_t from far byte-address __addr. The address is in the program memory.

◆ pgm_read_u8()

uint8_t pgm_read_u8 ( const uint8_t * __addr )

inlinestatic

Read an uint8_t from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_u8_far()

uint8_t pgm_read_u8_far ( uint_farptr_t __addr )

inlinestatic

Read an uint8_t from far byte-address __addr. The address is in the program memory.

◆ pgm_read_unsigned()

unsigned pgm_read_unsigned ( const unsigned * __addr )

inlinestatic

Read an unsigned from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_unsigned_char()

unsigned char pgm_read_unsigned_char ( const unsigned char * __addr )

inlinestatic

Read an unsigned char from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_unsigned_char_far()

unsigned char pgm_read_unsigned_char_far ( uint_farptr_t __addr )

inlinestatic

Read an unsigned char from far byte-address __addr. The address is in the program memory.

◆ pgm_read_unsigned_far()

unsigned pgm_read_unsigned_far ( uint_farptr_t __addr )

inlinestatic

Read an unsigned from far byte-address __addr. The address is in the program memory.

◆ pgm_read_unsigned_int()

unsigned int pgm_read_unsigned_int ( const unsigned int * __addr )

inlinestatic

Read an unsigned int from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_unsigned_int_far()

unsigned int pgm_read_unsigned_int_far ( uint_farptr_t __addr )

inlinestatic

Read an unsigned int from far byte-address __addr. The address is in the program memory.

◆ pgm_read_unsigned_long()

unsigned long pgm_read_unsigned_long ( const unsigned long * __addr )

inlinestatic

Read an unsigned long from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_unsigned_long_far()

unsigned long pgm_read_unsigned_long_far ( uint_farptr_t __addr )

inlinestatic

Read an unsigned long from far byte-address __addr. The address is in the program memory.

◆ pgm_read_unsigned_long_long()

unsigned long long pgm_read_unsigned_long_long ( const unsigned long long * __addr )

inlinestatic

Read an unsigned long long from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_unsigned_long_long_far()

unsigned long long pgm_read_unsigned_long_long_far ( uint_farptr_t __addr )

inlinestatic

Read an unsigned long long from far byte-address __addr. The address is in the program memory.

◆ pgm_read_unsigned_short()

unsigned short pgm_read_unsigned_short ( const unsigned short * __addr )

inlinestatic

Read an unsigned short from 16-bit (near) byte-address __addr. The address is in the lower 64 KiB of program memory.

◆ pgm_read_unsigned_short_far()

unsigned short pgm_read_unsigned_short_far ( uint_farptr_t __addr )

inlinestatic

Read an unsigned short from far byte-address __addr. The address is in the program memory.

◆ strcasecmp_P()

int strcasecmp_P	(	const char *	s1,
		const char *	s2
	)

Compare two strings ignoring case.

The strcasecmp_P() function compares the two strings s1 and s2, ignoring the case of the characters.

Parameters

s1	A pointer to a string in the devices SRAM.
s2	A pointer to a string in the devices Flash.

Returns: The strcasecmp_P() function returns an integer less than, equal to, or greater than zero if s1 is found, respectively, to be less than, to match, or be greater than s2. A consequence of the ordering used by strcasecmp_P() is that if s1 is an initial substring of s2, then s1 is considered to be "less than" s2.

◆ strcasecmp_PF()

int strcasecmp_PF	(	const char *	s1,
		uint_farptr_t	s2
	)

Compare two strings ignoring case.

The strcasecmp_PF() function compares the two strings s1 and s2, ignoring the case of the characters.

Parameters

s1	A pointer to the first string in SRAM
s2	A far pointer to the second string in Flash

Returns: The strcasecmp_PF() function returns an integer less than, equal to, or greater than zero if s1 is found, respectively, to be less than, to match, or be greater than s2. The contents of RAMPZ SFR are undefined when the function returns.

◆ strcasestr_P()

char * strcasestr_P	(	const char *	s1,
		const char *	s2
	)

This funtion is similar to strcasestr() except that s2 is pointer to a string in program space.

◆ strcat_P()

char * strcat_P	(	char *	dest,
		const char *	src
	)

The strcat_P() function is similar to strcat() except that the src string must be located in program space (flash).

Returns: The strcat() function returns a pointer to the resulting string dest.

◆ strcat_PF()

char * strcat_PF	(	char *	dst,
		uint_farptr_t	src
	)

Concatenates two strings.

The strcat_PF() function is similar to strcat() except that the src string must be located in program space (flash) and is addressed using a far pointer

Parameters

dst	A pointer to the destination string in SRAM
src	A far pointer to the string to be appended in Flash

Returns: The strcat_PF() function returns a pointer to the resulting string dst. The contents of RAMPZ SFR are undefined when the function returns

◆ strchr_P()

const char * strchr_P	(	const char *	s,
		int	val
	)

Locate character in program space string.

The strchr_P() function locates the first occurrence of val (converted to a char) in the string pointed to by s in program space. The terminating null character is considered to be part of the string.

The strchr_P() function is similar to strchr() except that s is pointer to a string in program space.

Returns: The strchr_P() function returns a pointer to the matched character or NULL if the character is not found.

◆ strchr_PF()

uint_farptr_t strchr_PF	(	uint_farptr_t	s,
		int	val
	)

Locate character in far program space string.

The strchr_PF() function locates the first occurrence of val (converted to a char) in the string pointed to by s in far program space. The terminating null character is considered to be part of the string.

The strchr_PF() function is similar to strchr() except that s is a far pointer to a string in program space that's not required to be located in the lower 64 KiB block like it is the case for strchr_P().

Returns: The strchr_PF() function returns a far pointer to the matched character or 0 if the character is not found.

◆ strchrnul_P()

const char * strchrnul_P	(	const char *	s,
		int	c
	)

The strchrnul_P() function is like strchr_P() except that if c is not found in s, then it returns a pointer to the null byte at the end of s, rather than NULL. (Glibc, GNU extension.)

Returns: The strchrnul_P() function returns a pointer to the matched character, or a pointer to the null byte at the end of s (i.e., s+strlen(s)) if the character is not found.

◆ strcmp_P()

int strcmp_P	(	const char *	s1,
		const char *	s2
	)

The strcmp_P() function is similar to strcmp() except that s2 is pointer to a string in program space.

Returns: The strcmp_P() function returns an integer less than, equal to, or greater than zero if s1 is found, respectively, to be less than, to match, or be greater than s2. A consequence of the ordering used by strcmp_P() is that if s1 is an initial substring of s2, then s1 is considered to be "less than" s2.

◆ strcmp_PF()

int strcmp_PF	(	const char *	s1,
		uint_farptr_t	s2
	)

Compares two strings.

The strcmp_PF() function is similar to strcmp() except that s2 is a far pointer to a string in program space.

Parameters

s1	A pointer to the first string in SRAM
s2	A far pointer to the second string in Flash

Returns: The strcmp_PF() function returns an integer less than, equal to, or greater than zero if s1 is found, respectively, to be less than, to match, or be greater than s2. The contents of RAMPZ SFR are undefined when the function returns.

◆ strcpy_P()

char * strcpy_P	(	char *	dest,
		const char *	src
	)

The strcpy_P() function is similar to strcpy() except that src is a pointer to a string in program space.

Returns: The strcpy_P() function returns a pointer to the destination string dest.

◆ strcpy_PF()

char * strcpy_PF	(	char *	dst,
		uint_farptr_t	src
	)

Duplicate a string.

The strcpy_PF() function is similar to strcpy() except that src is a far pointer to a string in program space.

Parameters

dst	A pointer to the destination string in SRAM
src	A far pointer to the source string in Flash

Returns: The strcpy_PF() function returns a pointer to the destination string dst. The contents of RAMPZ SFR are undefined when the funcion returns.

◆ strcspn_P()

size_t strcspn_P	(	const char *	s,
		const char *	reject
	)

The strcspn_P() function calculates the length of the initial segment of s which consists entirely of characters not in reject. This function is similar to strcspn() except that reject is a pointer to a string in program space.

Returns: The strcspn_P() function returns the number of characters in the initial segment of s which are not in the string reject. The terminating zero is not considered as a part of string.

◆ strlcat_P()

size_t strlcat_P	(	char *	dst,
		const char *	src,
		size_t	siz
	)

Concatenate two strings.

The strlcat_P() function is similar to strlcat(), except that the src string must be located in program space (flash).

Appends src to string dst of size siz (unlike strncat(), siz is the full size of dst, not space left). At most siz-1 characters will be copied. Always NULL terminates (unless siz <= strlen(dst)).

Returns: The strlcat_P() function returns strlen(src) + MIN(siz, strlen(initial dst)). If retval >= siz, truncation occurred.

◆ strlcat_PF()

size_t strlcat_PF	(	char *	dst,
		uint_farptr_t	src,
		size_t	n
	)

Concatenate two strings.

The strlcat_PF() function is similar to strlcat(), except that the src string must be located in program space (flash) and is addressed using a far pointer.

Appends src to string dst of size n (unlike strncat(), n is the full size of dst, not space left). At most n-1 characters will be copied. Always NULL terminates (unless n <= strlen(dst)).

Parameters

dst	A pointer to the destination string in SRAM
src	A far pointer to the source string in Flash
n	The total number of bytes allocated to the destination string

Returns: The strlcat_PF() function returns strlen(src) + MIN(n, strlen(initial dst)). If retval >= n, truncation occurred. The contents of RAMPZ SFR are undefined when the funcion returns.

◆ strlcpy_P()

size_t strlcpy_P	(	char *	dst,
		const char *	src,
		size_t	siz
	)

Copy a string from progmem to RAM.

Copy src to string dst of size siz. At most siz-1 characters will be copied. Always NULL terminates (unless siz == 0). The strlcpy_P() function is similar to strlcpy() except that the src is pointer to a string in memory space.

Returns: The strlcpy_P() function returns strlen(src). If retval >= siz, truncation occurred.

◆ strlcpy_PF()

size_t strlcpy_PF	(	char *	dst,
		uint_farptr_t	src,
		size_t	siz
	)

Copy a string from progmem to RAM.

Copy src to string dst of size siz. At most siz-1 characters will be copied. Always NULL terminates (unless siz == 0).

Returns: The strlcpy_PF() function returns strlen(src). If retval >= siz, truncation occurred. The contents of RAMPZ SFR are undefined when the function returns.

◆ strlen_P()

size_t strlen_P ( const char * src )

inlinestatic

The strlen_P() function is similar to strlen(), except that src is a pointer to a string in program space.

Returns: The strlen_P() function returns the number of characters in src.

Note: strlen_P() is implemented as an inline function in the avr/pgmspace.h header file, which will check if the length of the string is a constant and known at compile time. If it is not known at compile time, the macro will issue a call to __strlen_P() which will then calculate the length of the string as normal.

◆ strlen_PF()

size_t strlen_PF ( uint_farptr_t s )

Obtain the length of a string.

The strlen_PF() function is similar to strlen(), except that s is a far pointer to a string in program space.

Parameters

s	A far pointer to the string in flash

Returns: The strlen_PF() function returns the number of characters in s. The contents of RAMPZ SFR are undefined when the function returns.

◆ strncasecmp_P()

int strncasecmp_P	(	const char *	s1,
		const char *	s2,
		size_t	n
	)

Compare two strings ignoring case.

The strncasecmp_P() function is similar to strcasecmp_P(), except it only compares the first n characters of s1.

Parameters

s1	A pointer to a string in the devices SRAM.
s2	A pointer to a string in the devices Flash.
n	The maximum number of bytes to compare.

Returns: The strncasecmp_P() function returns an integer less than, equal to, or greater than zero if s1 (or the first n bytes thereof) is found, respectively, to be less than, to match, or be greater than s2. A consequence of the ordering used by strncasecmp_P() is that if s1 is an initial substring of s2, then s1 is considered to be "less than" s2.

◆ strncasecmp_PF()

int strncasecmp_PF	(	const char *	s1,
		uint_farptr_t	s2,
		size_t	n
	)

Compare two strings ignoring case.

The strncasecmp_PF() function is similar to strcasecmp_PF(), except it only compares the first n characters of s1 and the string in flash is addressed using a far pointer.

Parameters

s1	A pointer to a string in SRAM
s2	A far pointer to a string in Flash
n	The maximum number of bytes to compare

Returns: The strncasecmp_PF() function returns an integer less than, equal to, or greater than zero if s1 (or the first n bytes thereof) is found, respectively, to be less than, to match, or be greater than s2. The contents of RAMPZ SFR are undefined when the function returns.

◆ strncat_P()

char * strncat_P	(	char *	dest,
		const char *	src,
		size_t	len
	)

Concatenate two strings.

The strncat_P() function is similar to strncat(), except that the src string must be located in program space (flash).

Returns: The strncat_P() function returns a pointer to the resulting string dest.

◆ strncat_PF()

char * strncat_PF	(	char *	dst,
		uint_farptr_t	src,
		size_t	n
	)

Concatenate two strings.

The strncat_PF() function is similar to strncat(), except that the src string must be located in program space (flash) and is addressed using a far pointer.

Parameters

dst	A pointer to the destination string in SRAM
src	A far pointer to the source string in Flash
n	The maximum number of bytes to append

Returns: The strncat_PF() function returns a pointer to the resulting string dst. The contents of RAMPZ SFR are undefined when the function returns.

◆ strncmp_P()

int strncmp_P	(	const char *	s1,
		const char *	s2,
		size_t	n
	)

The strncmp_P() function is similar to strcmp_P() except it only compares the first (at most) n characters of s1 and s2.

Returns: The strncmp_P() function returns an integer less than, equal to, or greater than zero if s1 (or the first n bytes thereof) is found, respectively, to be less than, to match, or be greater than s2.

◆ strncmp_PF()

int strncmp_PF	(	const char *	s1,
		uint_farptr_t	s2,
		size_t	n
	)

Compare two strings with limited length.

The strncmp_PF() function is similar to strcmp_PF() except it only compares the first (at most) n characters of s1 and s2.

Parameters

s1	A pointer to the first string in SRAM
s2	A far pointer to the second string in Flash
n	The maximum number of bytes to compare

Returns: The strncmp_PF() function returns an integer less than, equal to, or greater than zero if s1 (or the first n bytes thereof) is found, respectively, to be less than, to match, or be greater than s2. The contents of RAMPZ SFR are undefined when the function returns.

◆ strncpy_P()

char * strncpy_P	(	char *	dest,
		const char *	src,
		size_t	n
	)

The strncpy_P() function is similar to strcpy_P() except that not more than n bytes of src are copied. Thus, if there is no null byte among the first n bytes of src, the result will not be null-terminated.

In the case where the length of src is less than that of n, the remainder of dest will be padded with nulls.

Returns: The strncpy_P() function returns a pointer to the destination string dest.

◆ strncpy_PF()

char * strncpy_PF	(	char *	dst,
		uint_farptr_t	src,
		size_t	n
	)

Duplicate a string until a limited length.

The strncpy_PF() function is similar to strcpy_PF() except that not more than n bytes of src are copied. Thus, if there is no null byte among the first n bytes of src, the result will not be null-terminated.

In the case where the length of src is less than that of n, the remainder of dst will be padded with nulls.

Parameters

dst	A pointer to the destination string in SRAM
src	A far pointer to the source string in Flash
n	The maximum number of bytes to copy

Returns: The strncpy_PF() function returns a pointer to the destination string dst. The contents of RAMPZ SFR are undefined when the function returns.

◆ strnlen_P()

size_t strnlen_P	(	const char *	src,
		size_t	len
	)

Determine the length of a fixed-size string.

The strnlen_P() function is similar to strnlen(), except that src is a pointer to a string in program space.

Returns: The strnlen_P function returns strlen_P(src), if that is less than len, or len if there is no '\0' character among the first len characters pointed to by src.

◆ strnlen_PF()

size_t strnlen_PF	(	uint_farptr_t	s,
		size_t	len
	)

Determine the length of a fixed-size string.

The strnlen_PF() function is similar to strnlen(), except that s is a far pointer to a string in program space.

Parameters

s	A far pointer to the string in Flash
len	The maximum number of length to return

Returns: The strnlen_PF function returns strlen_P(s), if that is less than len, or len if there is no '\0' character among the first len characters pointed to by s. The contents of RAMPZ SFR are undefined when the function returns.

◆ strpbrk_P()

char * strpbrk_P	(	const char *	s,
		const char *	accept
	)

The strpbrk_P() function locates the first occurrence in the string s of any of the characters in the flash string accept. This function is similar to strpbrk() except that accept is a pointer to a string in program space.

Returns: The strpbrk_P() function returns a pointer to the character in s that matches one of the characters in accept, or NULL if no such character is found. The terminating zero is not considered as a part of string: if one or both args are empty, the result will NULL.

◆ strrchr_P()

const char * strrchr_P	(	const char *	s,
		int	val
	)

Locate character in string.

The strrchr_P() function returns a pointer to the last occurrence of the character val in the flash string s.

Returns: The strrchr_P() function returns a pointer to the matched character or NULL if the character is not found.

◆ strsep_P()

char * strsep_P	(	char **	sp,
		const char *	delim
	)

Parse a string into tokens.

The strsep_P() function locates, in the string referenced by *sp, the first occurrence of any character in the string delim (or the terminating '\0' character) and replaces it with a '\0'. The location of the next character after the delimiter character (or NULL, if the end of the string was reached) is stored in *sp. An ``empty'' field, i.e. one caused by two adjacent delimiter characters, can be detected by comparing the location referenced by the pointer returned in *sp to '\0'. This function is similar to strsep() except that delim is a pointer to a string in program space.

Returns: The strsep_P() function returns a pointer to the original value of *sp. If *sp is initially NULL, strsep_P() returns NULL.

◆ strspn_P()

size_t strspn_P	(	const char *	s,
		const char *	accept
	)

The strspn_P() function calculates the length of the initial segment of s which consists entirely of characters in accept. This function is similar to strspn() except that accept is a pointer to a string in program space.

Returns: The strspn_P() function returns the number of characters in the initial segment of s which consist only of characters from accept. The terminating zero is not considered as a part of string.

◆ strstr_P()

char * strstr_P	(	const char *	s1,
		const char *	s2
	)

Locate a substring.

The strstr_P() function finds the first occurrence of the substring s2 in the string s1. The terminating '\0' characters are not compared. The strstr_P() function is similar to strstr() except that s2 is pointer to a string in program space.

Returns: The strstr_P() function returns a pointer to the beginning of the substring, or NULL if the substring is not found. If s2 points to a string of zero length, the function returns s1.

◆ strstr_PF()

char * strstr_PF	(	const char *	s1,
		uint_farptr_t	s2
	)

Locate a substring.

The strstr_PF() function finds the first occurrence of the substring s2 in the string s1. The terminating '\0' characters are not compared. The strstr_PF() function is similar to strstr() except that s2 is a far pointer to a string in program space.

Returns: The strstr_PF() function returns a pointer to the beginning of the substring, or NULL if the substring is not found. If s2 points to a string of zero length, the function returns s1. The contents of RAMPZ SFR are undefined when the function returns.

◆ strtok_P()

char * strtok_P	(	char *	s,
		const char *	delim
	)

Parses the string into tokens.

strtok_P() parses the string s into tokens. The first call to strtok_P() should have s as its first argument. Subsequent calls should have the first argument set to NULL. If a token ends with a delimiter, this delimiting character is overwritten with a '\0' and a pointer to the next character is saved for the next call to strtok_P(). The delimiter string delim may be different for each call.

The strtok_P() function is similar to strtok() except that delim is pointer to a string in program space.

Returns: The strtok_P() function returns a pointer to the next token or NULL when no more tokens are found.

Note: strtok_P() is NOT reentrant. For a reentrant version of this function see strtok_rP().

◆ strtok_rP()

char * strtok_rP	(	char *	string,
		const char *	delim,
		char **	last
	)

Parses string into tokens.

The strtok_rP() function parses string into tokens. The first call to strtok_rP() should have string as its first argument. Subsequent calls should have the first argument set to NULL. If a token ends with a delimiter, this delimiting character is overwritten with a '\0' and a pointer to the next character is saved for the next call to strtok_rP(). The delimiter string delim may be different for each call. last is a user allocated char* pointer. It must be the same while parsing the same string. strtok_rP() is a reentrant version of strtok_P().

The strtok_rP() function is similar to strtok_r() except that delim is pointer to a string in program space.

Returns: The strtok_rP() function returns a pointer to the next token or NULL when no more tokens are found.

AVR-LibC Documentation					AVR-LibC Development Pages
Main Page	User Manual	Library Reference	FAQ	Example Projects	File List

AVR-LibC Documentation

AVR-LibC Development Pages

Main Page

User Manual

Library Reference

FAQ

Example Projects

File List

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ pgm_get_far_address

◆ pgm_read_byte

◆ pgm_read_byte_far

◆ pgm_read_byte_near

◆ pgm_read_dword

◆ pgm_read_dword_far

◆ pgm_read_dword_near

◆ pgm_read_float_near

◆ pgm_read_ptr

◆ pgm_read_ptr_far

◆ pgm_read_ptr_near

◆ pgm_read_qword

◆ pgm_read_qword_far

◆ pgm_read_qword_near

◆ pgm_read_word

◆ pgm_read_word_far

◆ pgm_read_word_near

◆ PROGMEM

◆ PROGMEM_FAR

◆ PSTR

◆ PSTR_FAR

Function Documentation

◆ memccpy_P()

◆ memchr_P()

◆ memcmp_P()

◆ memcmp_PF()

◆ memcpy_P()

◆ memcpy_PF()

◆ memmem_P()

◆ memrchr_P()

◆ pgm_read< T >()

◆ pgm_read_char()

◆ pgm_read_char_far()

◆ pgm_read_double()

◆ pgm_read_double_far()

◆ pgm_read_far< T >()

◆ pgm_read_float()

◆ pgm_read_float_far()

◆ pgm_read_i16()

◆ pgm_read_i16_far()

◆ pgm_read_i24()

◆ pgm_read_i24_far()

◆ pgm_read_i32()

◆ pgm_read_i32_far()

◆ pgm_read_i64()

◆ pgm_read_i64_far()

◆ pgm_read_i8()

◆ pgm_read_i8_far()

◆ pgm_read_int()

◆ pgm_read_int_far()

◆ pgm_read_long()

◆ pgm_read_long_double()

◆ pgm_read_long_double_far()

◆ pgm_read_long_far()

◆ pgm_read_long_long()

◆ pgm_read_long_long_far()

◆ pgm_read_short()

◆ pgm_read_short_far()

◆ pgm_read_signed()

◆ pgm_read_signed_char()

◆ pgm_read_signed_char_far()

◆ pgm_read_signed_far()

◆ pgm_read_signed_int()

◆ pgm_read_signed_int_far()

◆ pgm_read_u16()

◆ pgm_read_u16_far()

◆ pgm_read_u24()

◆ pgm_read_u24_far()