344 lines
9.2 KiB
C
344 lines
9.2 KiB
C
/*
|
|
* Copyright (c) 2021-2023 HPMicro
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*
|
|
*/
|
|
|
|
#ifndef _HPM_COMMON_H
|
|
#define _HPM_COMMON_H
|
|
|
|
#include <assert.h>
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
#include <string.h>
|
|
#include <stdlib.h>
|
|
|
|
/**
|
|
*
|
|
* @brief COMMON driver APIs
|
|
* @defgroup common_interface COMMON driver APIs
|
|
* @{
|
|
*
|
|
*/
|
|
|
|
#define __R volatile const /* Define "read-only" permission */
|
|
#define __RW volatile /* Define "read-write" permission */
|
|
#define __W volatile /* Define "write-only" permission */
|
|
|
|
#ifndef __I
|
|
#define __I __R
|
|
#endif
|
|
|
|
#ifndef __IO
|
|
#define __IO __RW
|
|
#endif
|
|
|
|
#ifndef __O
|
|
#define __O __W
|
|
#endif
|
|
|
|
#ifndef ARRAY_SIZE
|
|
#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
|
|
#endif
|
|
|
|
#ifndef MAX
|
|
#define MAX(a, b) ((a) > (b) ? (a) : (b))
|
|
#endif
|
|
#ifndef MIN
|
|
#define MIN(a, b) ((a) < (b) ? (a) : (b))
|
|
#endif
|
|
|
|
#ifndef HPM_ALIGN_DOWN
|
|
#define HPM_ALIGN_DOWN(a, n) ((uint32_t)(a) & ~(n-1U))
|
|
#endif
|
|
|
|
#ifndef HPM_ALIGN_UP
|
|
#define HPM_ALIGN_UP(a, n) (((uint32_t)(a) + (n-1U)) & ~(n-1U))
|
|
#endif
|
|
|
|
#define HPM_BITSMASK(val, offset) ((uint32_t)(val) << (offset))
|
|
#define IS_HPM_BITMASK_SET(val, mask) (((uint32_t)(val) & (uint32_t)(mask)) != 0U)
|
|
#define IS_HPM_BIT_SET(val, offset) (((uint32_t)(val) & (1UL << (offset))) != 0U)
|
|
#define IS_HPM_BITMASK_CLR(val, mask) (((uint32_t)(val) & (uint32_t)(mask)) == 0U)
|
|
#define IS_HPM_BIT_CLR(val, offset) (((uint32_t)(val) & (1UL << (offset))) == 0U)
|
|
|
|
#define HPM_BREAK_IF(cond) if (cond) { break; }
|
|
#define HPM_CONTINUE_IF(cond) if (cond) { continue; }
|
|
|
|
#define HPM_DIV_ROUND_CLOSEST(x, div) (((x) + (div) / 2) / (div))
|
|
#define HPM_DIV_ROUND_UP(x, div) (((x) + (div) - 1) / (div))
|
|
|
|
#define HPM_NUM_TO_EVEN_CEILING(x) ((x + 1) & 0xFFFFFFFEUL)
|
|
#define HPM_NUM_TO_EVEN_FLOOR(x) ((x) & 0xFFFFFFFEUL)
|
|
|
|
#define HPM_CHECK_RET(x) \
|
|
do { \
|
|
stat = (x); \
|
|
if (status_success != stat) { \
|
|
return stat; \
|
|
} \
|
|
} while (false)
|
|
|
|
#define SIZE_1KB (1024UL)
|
|
#define SIZE_1MB (1048576UL)
|
|
|
|
#define BIT0_MASK (0x00000001UL)
|
|
#define BIT1_MASK (0x00000002UL)
|
|
#define BIT2_MASK (0x00000004UL)
|
|
#define BIT3_MASK (0x00000008UL)
|
|
#define BIT4_MASK (0x00000010UL)
|
|
#define BIT5_MASK (0x00000020UL)
|
|
#define BIT6_MASK (0x00000040UL)
|
|
#define BIT7_MASK (0x00000080UL)
|
|
#define BIT8_MASK (0x00000100UL)
|
|
#define BIT9_MASK (0x00000200UL)
|
|
#define BIT10_MASK (0x00000400UL)
|
|
#define BIT11_MASK (0x00000800UL)
|
|
#define BIT12_MASK (0x00001000UL)
|
|
#define BIT13_MASK (0x00002000UL)
|
|
#define BIT14_MASK (0x00004000UL)
|
|
#define BIT15_MASK (0x00008000UL)
|
|
#define BIT16_MASK (0x00010000UL)
|
|
#define BIT17_MASK (0x00020000UL)
|
|
#define BIT18_MASK (0x00040000UL)
|
|
#define BIT19_MASK (0x00080000UL)
|
|
#define BIT20_MASK (0x00100000UL)
|
|
#define BIT21_MASK (0x00200000UL)
|
|
#define BIT22_MASK (0x00400000UL)
|
|
#define BIT23_MASK (0x00800000UL)
|
|
#define BIT24_MASK (0x01000000UL)
|
|
#define BIT25_MASK (0x02000000UL)
|
|
#define BIT26_MASK (0x04000000UL)
|
|
#define BIT27_MASK (0x08000000UL)
|
|
#define BIT28_MASK (0x10000000UL)
|
|
#define BIT29_MASK (0x20000000UL)
|
|
#define BIT30_MASK (0x40000000UL)
|
|
#define BIT31_MASK (0x80000000UL)
|
|
|
|
typedef uint32_t hpm_stat_t;
|
|
|
|
/* @brief Enum definition for the Status group
|
|
* Rule:
|
|
* [Group] 0-999 for the SoC driver and the corresponding components
|
|
* 1000 or above for the application status group
|
|
* [Code] Valid value: 0-999
|
|
*
|
|
*/
|
|
#define MAKE_STATUS(group, code) ((uint32_t)(group)*1000U + (uint32_t)(code))
|
|
/* @brief System status group definitions */
|
|
enum {
|
|
status_group_common = 0,
|
|
status_group_uart = 1,
|
|
status_group_i2c = 2,
|
|
status_group_spi = 3,
|
|
status_group_usb = 4,
|
|
status_group_i2s = 5,
|
|
status_group_xpi = 6,
|
|
status_group_l1c,
|
|
status_group_dma,
|
|
status_group_femc,
|
|
status_group_sdp,
|
|
status_group_xpi_nor,
|
|
status_group_otp,
|
|
status_group_lcdc,
|
|
status_group_mbx,
|
|
status_group_rng,
|
|
status_group_pdma,
|
|
status_group_wdg,
|
|
status_group_pmic_sec,
|
|
status_group_can,
|
|
status_group_sdxc,
|
|
status_group_pcfg,
|
|
status_group_clk,
|
|
status_group_pllctl,
|
|
status_group_pllctlv2,
|
|
status_group_ffa,
|
|
status_group_mcan,
|
|
status_group_ewdg,
|
|
|
|
status_group_middleware_start = 500,
|
|
status_group_sdmmc = status_group_middleware_start,
|
|
status_group_audio_codec,
|
|
status_group_dma_manager,
|
|
status_group_spi_nor_flash,
|
|
status_group_touch,
|
|
};
|
|
|
|
/* @brief Common status code definitions */
|
|
enum {
|
|
status_success = MAKE_STATUS(status_group_common, 0),
|
|
status_fail = MAKE_STATUS(status_group_common, 1),
|
|
status_invalid_argument = MAKE_STATUS(status_group_common, 2),
|
|
status_timeout = MAKE_STATUS(status_group_common, 3),
|
|
};
|
|
|
|
#if defined(__GNUC__)
|
|
|
|
/* alway_inline */
|
|
#define ATTR_ALWAYS_INLINE __attribute__((always_inline))
|
|
|
|
/* weak */
|
|
#define ATTR_WEAK __attribute__((weak))
|
|
|
|
/* alignment */
|
|
#define ATTR_ALIGN(alignment) __attribute__((aligned(alignment)))
|
|
|
|
/* place var_declare at section_name, e.x. PLACE_AT(".target_section", var); */
|
|
#define ATTR_PLACE_AT(section_name) __attribute__((section(section_name)))
|
|
|
|
#define ATTR_PLACE_AT_WITH_ALIGNMENT(section_name, alignment) \
|
|
ATTR_PLACE_AT(section_name) ATTR_ALIGN(alignment)
|
|
|
|
#define ATTR_PLACE_AT_NONCACHEABLE ATTR_PLACE_AT(".noncacheable.bss")
|
|
#define ATTR_PLACE_AT_NONCACHEABLE_WITH_ALIGNMENT(alignment) \
|
|
ATTR_PLACE_AT_NONCACHEABLE ATTR_ALIGN(alignment)
|
|
|
|
#define ATTR_PLACE_AT_NONCACHEABLE_BSS ATTR_PLACE_AT(".noncacheable.bss")
|
|
#define ATTR_PLACE_AT_NONCACHEABLE_BSS_WITH_ALIGNMENT(alignment) \
|
|
ATTR_PLACE_AT_NONCACHEABLE_BSS ATTR_ALIGN(alignment)
|
|
|
|
/* initialize variable x with y using PLACE_AT_NONCACHEABLE_INIT(x) = {y}; */
|
|
#define ATTR_PLACE_AT_NONCACHEABLE_INIT ATTR_PLACE_AT(".noncacheable.init")
|
|
#define ATTR_PLACE_AT_NONCACHEABLE_INIT_WITH_ALIGNMENT(alignment) \
|
|
ATTR_PLACE_AT_NONCACHEABLE_INIT ATTR_ALIGN(alignment)
|
|
|
|
#define ATTR_RAMFUNC ATTR_PLACE_AT(".fast")
|
|
#define ATTR_RAMFUNC_WITH_ALIGNMENT(alignment) \
|
|
ATTR_RAMFUNC ATTR_ALIGN(alignment)
|
|
|
|
#define ATTR_SHARE_MEM ATTR_PLACE_AT(".sh_mem")
|
|
|
|
#define NOP() __asm volatile("nop")
|
|
#define WFI() __asm volatile("wfi")
|
|
|
|
#define HPM_ATTR_MACHINE_INTERRUPT __attribute__ ((section(".isr_vector"), interrupt("machine"), aligned(4)))
|
|
#define HPM_ATTR_SUPERVISOR_INTERRUPT __attribute__ ((section(".isr_s_vector"), interrupt("supervisor"), aligned(4)))
|
|
|
|
#elif defined(__ICCRISCV__)
|
|
|
|
|
|
/* alway_inline */
|
|
#define ATTR_ALWAYS_INLINE __attribute__((always_inline))
|
|
|
|
/* weak */
|
|
#define ATTR_WEAK __weak
|
|
|
|
/* alignment */
|
|
#define ATTR_ALIGN(alignment) __attribute__((aligned(alignment)))
|
|
|
|
/* place var_declare at section_name, e.x. PLACE_AT(".target_section", var); */
|
|
#define ATTR_PLACE_AT(section_name) __attribute__((section(section_name)))
|
|
|
|
#define ATTR_PLACE_AT_WITH_ALIGNMENT(section_name, alignment) \
|
|
ATTR_PLACE_AT(section_name) ATTR_ALIGN(alignment)
|
|
|
|
#define ATTR_PLACE_AT_NONCACHEABLE ATTR_PLACE_AT(".noncacheable.bss")
|
|
#define ATTR_PLACE_AT_NONCACHEABLE_WITH_ALIGNMENT(alignment) \
|
|
ATTR_PLACE_AT_NONCACHEABLE ATTR_ALIGN(alignment)
|
|
|
|
#define ATTR_PLACE_AT_NONCACHEABLE_BSS ATTR_PLACE_AT(".noncacheable.bss")
|
|
#define ATTR_PLACE_AT_NONCACHEABLE_BSS_WITH_ALIGNMENT(alignment) \
|
|
ATTR_PLACE_AT_NONCACHEABLE_BSS ATTR_ALIGN(alignment)
|
|
|
|
/* initialize variable x with y using PLACE_AT_NONCACHEABLE_INIT(x) = {y}; */
|
|
#define ATTR_PLACE_AT_NONCACHEABLE_INIT ATTR_PLACE_AT(".noncacheable.init")
|
|
#define ATTR_PLACE_AT_NONCACHEABLE_INIT_WITH_ALIGNMENT(alignment) \
|
|
ATTR_PLACE_AT_NONCACHEABLE_INIT ATTR_ALIGN(alignment)
|
|
|
|
#define ATTR_RAMFUNC ATTR_PLACE_AT(".fast")
|
|
#define ATTR_RAMFUNC_WITH_ALIGNMENT(alignment) \
|
|
ATTR_RAMFUNC ATTR_ALIGN(alignment)
|
|
|
|
#define ATTR_SHARE_MEM ATTR_PLACE_AT(".sh_mem")
|
|
|
|
#define NOP() __asm volatile("nop")
|
|
#define WFI() __asm volatile("wfi")
|
|
|
|
#define HPM_ATTR_MACHINE_INTERRUPT __machine __interrupt
|
|
#define HPM_ATTR_SUPERVISOR_INTERRUPT __supervisor __interrupt
|
|
|
|
#ifndef __TIMEVAL_DEFINED
|
|
#define __TIMEVAL_DEFINED 1
|
|
struct timeval {
|
|
long tv_sec; /* Seconds since the Epoch */
|
|
long tv_usec; /* Microseconds */
|
|
};
|
|
#endif
|
|
|
|
#else
|
|
#error Unknown toolchain
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
/**
|
|
* @brief Count bits set to 1
|
|
*
|
|
* @param value Data to be counted
|
|
*
|
|
* @return number of bits set to 1
|
|
*/
|
|
static inline uint32_t count_set_bits(uint32_t value)
|
|
{
|
|
if (value == 0) {
|
|
return 0;
|
|
}
|
|
return 1 + count_set_bits(value & (value - 1));
|
|
}
|
|
|
|
/**
|
|
* @brief Count bits set to 1 from least significant bit
|
|
*
|
|
* @param value Data to be counted
|
|
*
|
|
* @return number of bits set to 1
|
|
* @return 0xFFFFFFFF if no bit was set to 1
|
|
*/
|
|
static inline uint32_t get_first_set_bit_from_lsb(uint32_t value)
|
|
{
|
|
uint32_t i = 0;
|
|
if (!value) {
|
|
return 0xFFFFFFFFUL;
|
|
}
|
|
while (value && !(value & 0x1)) {
|
|
value >>= 1;
|
|
i++;
|
|
}
|
|
return i;
|
|
}
|
|
|
|
/**
|
|
* @brief Count bits set to 1 from most significant bit
|
|
*
|
|
* @param value Data to be counted
|
|
*
|
|
* @return number of bits set to 1
|
|
* @return 0xFFFFFFFF if no bit was set to 1
|
|
*/
|
|
static inline uint32_t get_first_set_bit_from_msb(uint32_t value)
|
|
{
|
|
uint32_t i = 31;
|
|
if (!value) {
|
|
return 0xFFFFFFFFUL;
|
|
}
|
|
while (value && !(value & 0x80000000)) {
|
|
value <<= 1;
|
|
value &= ~1;
|
|
i--;
|
|
}
|
|
return i;
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
#endif /* _HPM_COMMON_H */
|