flash_utils.h

Go to the documentation of this file.

/*
 * Copyright (C) 2022 Otto-von-Guericke-Universität Magdeburg
 *
 * This file is subject to the terms and conditions of the GNU Lesser General
 * Public License v2.1. See the file LICENSE in the top level directory for more
 * details.
 */
 
#ifndef FLASH_UTILS_H
#define FLASH_UTILS_H
 
#include <stdio.h>
#include <string.h>
 
#include "cpu_conf.h"
#include "kernel_defines.h"
 
#if IS_ACTIVE(HAS_FLASH_UTILS_ARCH)
#include "flash_utils_arch.h" /* IWYU pragma: export */
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(DOXYGEN)
#define FLASH_ATTR <IMPLEMTATION_DEFINED>
#define PRIsflash <IMPLEMTATION_DEFINED>
 
#define TO_FLASH(str_literal) <IMPLEMTATION_DEFINED>
 
int flash_strcmp(const char *ram, FLASH_ATTR const char *flash);
 
int flash_strncmp(const char *ram, FLASH_ATTR const char *flash, size_t n);
 
size_t flash_strlen(FLASH_ATTR const char *flash);
 
char * flash_strcpy(char *ram, FLASH_ATTR const char *flash);
 
char * flash_strncpy(char *ram, FLASH_ATTR const char *flash, size_t n);
 
int flash_printf(FLASH_ATTR const char *flash, ...);
 
int flash_vprintf(FLASH_ATTR const char *flash, va_list args);
 
int flash_fprintf(FILE *stream, FLASH_ATTR const char *flash, ...);
 
int flash_vfprintf(FILE *stream, FLASH_ATTR const char *flash, va_list args);
 
int flash_snprintf(char *buf, size_t buf_len, FLASH_ATTR const char *flash, ...);
 
int flash_vsnprintf(char *buf, size_t buf_len, FLASH_ATTR const char *flash,
                    va_list args);
 
void flash_puts(FLASH_ATTR const char *flash);
 
void * flash_memcpy(void *dest, FLASH_ATTR const void *src, size_t n);
#elif !IS_ACTIVE(HAS_FLASH_UTILS_ARCH)
#  define FLASH_ATTR
#  define PRIsflash "s"
#  define ASSERT_IS_STR_LITERAL_HELPER(x) x
#  define ASSERT_IS_STR_LITERAL(x) ASSERT_IS_STR_LITERAL_HELPER("" x)
#  define TO_FLASH(x) ASSERT_IS_STR_LITERAL(x)
#  define flash_strcmp strcmp
#  define flash_strncmp strncmp
#  define flash_strlen strlen
#  define flash_strcpy strcpy
#  define flash_strncpy strncpy
#  define flash_printf printf
#  define flash_vprintf vprintf
#  define flash_fprintf fprintf
#  define flash_vfprintf vfprintf
#  define flash_snprintf snprintf
#  define flash_vsnprintf vsnprintf
#  define flash_puts puts
#  define flash_memcpy memcpy
#endif
 
#define FLASH_PUTS(x) flash_puts(TO_FLASH(x))
 
static inline void flash_print_str(FLASH_ATTR const char *flash)
{
    printf("%" PRIsflash, flash);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* FLASH_UTILS_H */