220 lines
9.0 KiB
C
220 lines
9.0 KiB
C
/*******************************************************************************
|
|
* Copyright (C) 2020, Huada Semiconductor Co., Ltd. All rights reserved.
|
|
*
|
|
* This software component is licensed by HDSC under BSD 3-Clause license
|
|
* (the "License"); You may not use this file except in compliance with the
|
|
* License. You may obtain a copy of the License at:
|
|
* opensource.org/licenses/BSD-3-Clause
|
|
*/
|
|
/******************************************************************************/
|
|
/** \file hc32_common.h
|
|
**
|
|
** A detailed description is available at
|
|
** @link Hc32CommonGroup Hc32 Series Comm Part description @endlink
|
|
**
|
|
** - 2018-10-18 CDT First version for Hc32 Series of common part.
|
|
**
|
|
******************************************************************************/
|
|
#ifndef __HC32_COMMON_H__
|
|
#define __HC32_COMMON_H__
|
|
|
|
/*******************************************************************************
|
|
* Include files
|
|
******************************************************************************/
|
|
#include <string.h>
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
|
|
/* C binding of definitions if building with C++ compiler */
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
/**
|
|
*******************************************************************************
|
|
** \defgroup Hc32CommonGroup Hc32 Series Common Part(HC32COMMON)
|
|
**
|
|
******************************************************************************/
|
|
//@{
|
|
|
|
/*******************************************************************************
|
|
* Global type definitions ('typedef')
|
|
******************************************************************************/
|
|
/**
|
|
*******************************************************************************
|
|
** \brief single precision floating point number (4 byte)
|
|
******************************************************************************/
|
|
typedef float float32_t;
|
|
|
|
/**
|
|
*******************************************************************************
|
|
** \brief double precision floating point number (8 byte)
|
|
******************************************************************************/
|
|
typedef double float64_t;
|
|
|
|
/**
|
|
*******************************************************************************
|
|
** \brief function pointer type to void/void function
|
|
******************************************************************************/
|
|
typedef void (*func_ptr_t)(void);
|
|
|
|
/**
|
|
*******************************************************************************
|
|
** \brief function pointer type to void/uint8_t function
|
|
******************************************************************************/
|
|
typedef void (*func_ptr_arg1_t)(uint8_t);
|
|
|
|
/**
|
|
*******************************************************************************
|
|
** \brief functional state
|
|
******************************************************************************/
|
|
typedef enum en_functional_state
|
|
{
|
|
Disable = 0u,
|
|
Enable = 1u,
|
|
} en_functional_state_t;
|
|
|
|
/**
|
|
*******************************************************************************
|
|
** \brief flag status
|
|
******************************************************************************/
|
|
typedef enum en_flag_status
|
|
{
|
|
Reset = 0u,
|
|
Set = 1u,
|
|
} en_flag_status_t, en_int_status_t;
|
|
|
|
/**
|
|
*******************************************************************************
|
|
** \brief generic error codes
|
|
******************************************************************************/
|
|
typedef enum en_result
|
|
{
|
|
Ok = 0u, ///< No error
|
|
Error = 1u, ///< Non-specific error code
|
|
ErrorAddressAlignment = 2u, ///< Address alignment does not match
|
|
ErrorAccessRights = 3u, ///< Wrong mode (e.g. user/system) mode is set
|
|
ErrorInvalidParameter = 4u, ///< Provided parameter is not valid
|
|
ErrorOperationInProgress = 5u, ///< A conflicting or requested operation is still in progress
|
|
ErrorInvalidMode = 6u, ///< Operation not allowed in current mode
|
|
ErrorUninitialized = 7u, ///< Module (or part of it) was not initialized properly
|
|
ErrorBufferFull = 8u, ///< Circular buffer can not be written because the buffer is full
|
|
ErrorTimeout = 9u, ///< Time Out error occurred (e.g. I2C arbitration lost, Flash time-out, etc.)
|
|
ErrorNotReady = 10u, ///< A requested final state is not reached
|
|
OperationInProgress = 11u, ///< Indicator for operation in progress (e.g. ADC conversion not finished, DMA channel used, etc.)
|
|
} en_result_t;
|
|
|
|
/*******************************************************************************
|
|
* Global pre-processor symbols/macros ('#define')
|
|
******************************************************************************/
|
|
|
|
/**
|
|
*******************************************************************************
|
|
** \brief Device include
|
|
******************************************************************************/
|
|
#if defined(HC32F460)
|
|
#include "hc32f460.h"
|
|
#include "system_hc32f460.h"
|
|
#elif defined(HC32xxxx)
|
|
#include "hc32xxxx.h"
|
|
#include "system_hc32xxxx.h"
|
|
#else
|
|
#error "Please select first the target HC32xxxx device used in your application (in hc32xxxx.h file)"
|
|
#endif
|
|
|
|
/*! Weak and Align compiler definition */
|
|
#if defined ( __GNUC__ ) && !defined (__CC_ARM) /* GNU Compiler */
|
|
#ifndef __WEAKDEF
|
|
#define __WEAKDEF __attribute__((weak))
|
|
#endif /* __WEAKDEF */
|
|
#ifndef __ALIGN_BEGIN
|
|
#define __ALIGN_BEGIN __attribute__((aligned (4)))
|
|
#endif /* __ALIGN_BEGIN */
|
|
#ifndef __NOINLINE
|
|
#define __NOINLINE __attribute__((noinline))
|
|
#endif /* __NOINLINE */
|
|
#ifndef __UNUSED
|
|
#define __UNUSED __attribute__((unused))
|
|
#endif /* __UNUSED */
|
|
#ifndef __RAM_FUNC
|
|
#define __RAM_FUNC __attribute__((long_call, section(".ramfunc")))
|
|
/* Usage: void __RAM_FUNC foo(void) */
|
|
#endif /* __RAM_FUNC */
|
|
#elif defined (__ICCARM__) ///< IAR Compiler
|
|
#define __WEAKDEF __weak
|
|
#define __ALIGN_BEGIN _Pragma("data_alignment=4")
|
|
#define __NOINLINE _Pragma("optimize = no_inline")
|
|
#define __UNUSED __attribute__((unused))
|
|
#define __RAM_FUNC __ramfunc
|
|
#elif defined (__CC_ARM) ///< ARM Compiler
|
|
#define __WEAKDEF __attribute__((weak))
|
|
#define __ALIGN_BEGIN __align(4)
|
|
#define __NOINLINE __attribute__((noinline))
|
|
#define __UNUSED __attribute__((unused))
|
|
/* RAM functions are defined using the toolchain options.
|
|
Functions that are executed in RAM should reside in a separate source module.
|
|
Using the 'Options for File' dialog you can simply change the 'Code / Const'
|
|
area of a module to a memory space in physical RAM. */
|
|
#define __RAM_FUNC
|
|
#else
|
|
#error "unsupported compiler!!"
|
|
#endif /* __GNUC__ */
|
|
|
|
/*! Pointer correspond to zero value */
|
|
#if !defined (NULL)
|
|
#define NULL (0)
|
|
#endif
|
|
|
|
/*! Memory clear */
|
|
#define MEM_ZERO_STRUCT(x) do { \
|
|
memset((void*)&(x), 0L, (sizeof(x))); \
|
|
}while(0)
|
|
|
|
/*! Decimal to BCD */
|
|
#define DEC2BCD(x) ((((x) / 10u) << 4u) + ((x) % 10u))
|
|
|
|
/*! BCD to decimal */
|
|
#define BCD2DEC(x) ((((x) >> 4u) * 10u) + ((x) & 0x0Fu))
|
|
|
|
/*! Returns the minimum value out of two values */
|
|
#define MIN(x, y) ((x) < (y) ? (x) : (y))
|
|
|
|
/*! Returns the maximum value out of two values */
|
|
#define MAX(x, y) ((x) > (y) ? (x) : (y))
|
|
|
|
/*! Returns the dimension of an array */
|
|
#define ARRAY_SZ(X) (sizeof((X)) / sizeof((X)[0]))
|
|
|
|
/*! Check if it is a functional state */
|
|
#define IS_FUNCTIONAL_STATE(state) (((state) == Disable) || ((state) == Enable))
|
|
|
|
#define BIT_SET(value,bit) ((value) |= (bit))
|
|
|
|
#define BIT_CLEAR(value,bit) ((value) &= ~(bit))
|
|
|
|
#define BIT_READ(value,bit) ((value) & (bit))
|
|
|
|
#define BIT_VALUE(index) (1UL << (index))
|
|
|
|
/*******************************************************************************
|
|
* Global variable definitions ('extern')
|
|
******************************************************************************/
|
|
|
|
/*******************************************************************************
|
|
* Global function prototypes (definition in C source)
|
|
******************************************************************************/
|
|
|
|
//@} // Hc32CommonGroup
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __HC32_COMMON_H__ */
|
|
|
|
/*******************************************************************************
|
|
* EOF (not truncated)
|
|
******************************************************************************/
|