RAFW Flexible Software Package Documentation  Release v2.0.1

 
sdk_defs.h File Reference

Central include header file with platform definitions. More...

#include "bsp_api.h"
#include "config/bsp_definitions.h"
#include "config/bsp_sflash_map_ra6w1.h"
#include "config/bsp_defaults.h"
#include <stddef.h>
#include <stdbool.h>
#include <stdio.h>
#include "R7SA6W1CE.h"

Macros

#define MEMORY_REMAPPED_BASE
 Remapped device base address.
 
#define MEMORY_REMAPPED_SIZE
 Remapped device memory size.
 
#define MEMORY_ROM_BASE
 ROM base address.
 
#define MEMORY_ROM_SIZE
 ROM memory size.
 
#define MEMORY_OTP_BASE
 OTP memory base address.
 
#define MEMORY_OTP_SIZE
 OTP memory size.
 
#define MEMORY_SYSRAM_BASE
 SYSTEM RAM base address.
 
#define MEMORY_SYSRAM_SIZE
 SYSTEM RAM size.
 
#define MEMORY_CACHERAM_BASE
 CACHE RAM base address.
 
#define MEMORY_CACHERAM_SIZE
 CACHE RAM size.
 
#define MEMORY_OQSPIC_BASE
 QSPI Flash base address.
 
#define MEMORY_QSPIF_SIZE
 QSPI Flash memory size.
 
#define FLASH_SECTOR_SIZE
 The Sector Size of the OQSPI and QSPI flash memories.
 
#define OQSPI_MEM1_VIRTUAL_BASE_ADDR
 The base address for accessing the Flash memory connected to OQSPI. More...
 
#define IS_OQSPI_MEM1_VIRTUAL_ADDRESS(_a)
 Address is in OQSPI_MEM1 virtual memory region.
 
#define QSPI_MEM1_VIRTUAL_BASE_ADDR
 The base address for accessing the Flash memory connected to QSPIC. More...
 
#define WITHIN_RANGE(_a, _s, _e)
 OTP User Data Encryption Keys memory base address.
 
#define IS_REMAPPED_ADDRESS(_a)
 Address is in the remapped memory region.
 
#define IS_ROM_ADDRESS(_a)
 Address is in the ROM region.
 
#define IS_SYSRAM_ADDRESS(_a)
 Address is in the SYSTEM RAM region.
 
#define IS_CACHERAM_ADDRESS(_a)
 Address is in the CACHE RAM region.
 
#define IS_QSPIF_ADDRESS(_a)
 Address is in the QSPI Flash memory region.
 
#define IS_QSPIF_S_ADDRESS(_a)
 Address is in the QSPI AHB-S(ystem) memory region.
 
#define IS_OQSPIC_ADDRESS(_a)
 Address is in the OQSPI Flash memory region.
 
#define IS_OQSPIC_S_ADDRESS(_a)
 Address is in the OQSPI AHB-S(ystem) memory region.
 
#define __RETAINED
 Zero-initialized data retained memory attribute.
 
#define __RETAINED_RW
 Initialized data retained memory attribute.
 
#define __RETAINED_UNINIT
 Uninitialized data retained memory attribute. Used for variables that should not be initialized during startup.
 
#define __RETAINED_CONST_INIT
 Constant data retained memory attribute.
 
#define __RETAINED_CODE
 Text retained memory attribute.
 
#define __UNUSED
 Attribute to silence warnings about unused parameters/variables/function.
 
#define __LTO_EXT
 Attribute to tell the compiler to consider a symbol as externally visible (for LTO)
 
#define ASSERT_WARNING(a)
 Assert as warning macro. More...
 
#define ASSERT_ERROR(a)
 Assert as error macro.
 
#define ASSERT_WARNING_UNINIT(a)
 Assert as warning macro when the system is still uninitialized. More...
 
#define ASSERT_ERROR_UNINIT(a)
 Assert as error macro when the system is still uninitialized. More...
 
#define GLOBAL_INT_DISABLE()
 Macro to disable all interrupts. More...
 
#define GLOBAL_INT_RESTORE()
 Macro to restore all interrupts. More...
 
#define MIN(a, b)
 Macro the minimum of two values. More...
 
#define MAX(a, b)
 Macro the maximum of two values. More...
 
#define SWAP16(a)
 Macro to swap the bytes of a 16-bit variable. More...
 
#define SWAP32(a)
 Macro to swap the bytes of a 32-bit variable. More...
 
#define OPT_MEMCPY
 Optimized memcpy.
 
#define OPT_MEMMOVE
 Optimized memmove.
 
#define OPT_MEMSET(s, c, n)
 Optimized memset.
 
#define REG_MSK(base, reg, field)
 Access register field mask. More...
 
#define REG_POS(base, reg, field)
 Access register field position. More...
 
#define REG_GET_FIELD(base, reg, field, var)
 Access register field value. More...
 
#define REG_SET_FIELD(base, reg, field, var, val)
 Set register field value. More...
 
#define RAW_SET_FIELD(mem, mask, val)
 Set memory field value. More...
 
#define REG_CLR_FIELD(base, reg, field, var)
 Clear register field value. More...
 
#define REG_GET_ADDR_INDEXED(base, reg, interval, index)
 Get the address of a register value by index (provided a register interval) More...
 
#define REG_GETF_INDEXED(base, reg, field, interval, index)
 Return the value of a register field by index (provided a register interval). More...
 
#define REG_GETF(base, reg, field)
 Return the value of a register field. More...
 
#define RAW_GETF(addr, mask)
 Return the value of a memory field using a mask. More...
 
#define REG_SETF(base, reg, field, new_val)
 Set the value of a register field. More...
 
#define RAW_SETF(addr, mask, val)
 Set the value of a memory field. More...
 
#define REG_SET_BIT(base, reg, field)
 Set a bit of a register. More...
 
#define REG_CLR_BIT(base, reg, field)
 Clear a bit of a register. More...
 
#define REG_SET_MASKED(base, reg, mask, value)
 Sets register bits, indicated by the mask, to a value. More...
 
#define RAW_SET_MASKED(addr, mask, value)
 Sets memory bits, indicated by the mask, to a value. More...
 
#define BITS16(base, reg, field, v)
 Sets 16-bit wide register bits, indicated by the field, to a value v.
 
#define BITS32(base, reg, field, v)
 Sets 32-bit wide register bits, indicated by the field, to a value v.
 
#define GETBITS16(base, reg, v, field)
 Reads 16-bit wide register bits, indicated by the field, to a variable v.
 
#define GETBITS32(base, reg, v, field)
 Reads 32-bit wide register bits, indicated by the field, to a variable v.
 
#define ENABLE_DEBUGGER
 Macro to enable the debugger.
 
#define DISABLE_DEBUGGER
 Macro to disable the debugger.
 
#define SWRESET
 Macro to cause a software reset.
 
#define PORRESET
 Macro to cause a POR reset. it reset the DCORE.
 

Functions

void pll_off (void)
 Disable PLL.
 

Detailed Description

Central include header file with platform definitions.

Copyright (c) 2023 Renesas Electronics. All rights reserved.

This software ("Software") is owned by Renesas Electronics.

By using this Software you agree that Renesas Electronics retains all intellectual property and proprietary rights in and to this Software and any use, reproduction, disclosure or distribution of the Software without express written permission or a license agreement from Renesas Electronics is strictly prohibited. This Software is solely for use on or in conjunction with Renesas Electronics products.

EXCEPT AS OTHERWISE PROVIDED IN A LICENSE AGREEMENT BETWEEN THE PARTIES, THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. EXCEPT AS OTHERWISE PROVIDED IN A LICENSE AGREEMENT BETWEEN THE PARTIES, IN NO EVENT SHALL RENESAS ELECTRONICS BE LIABLE FOR ANY DIRECT, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE SOFTWARE.