335 lines
15 KiB
C
335 lines
15 KiB
C
/*
|
|
* @copyright (c) 2023-2024, MR Development Team
|
|
*
|
|
* @license SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* @date 2023-10-18 MacRsh First version
|
|
*/
|
|
|
|
#ifndef _MR_DEF_H_
|
|
#define _MR_DEF_H_
|
|
|
|
#include <stdint.h>
|
|
#include <stdarg.h>
|
|
#include <string.h>
|
|
#include <stdio.h>
|
|
#include "mr_config.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
/**
|
|
* @addtogroup Version
|
|
* @{
|
|
*/
|
|
#define MR_VERSION_MAJOR 0 /**< Major version (X.y.z) */
|
|
#define MR_VERSION_MINOR 0 /**< Minor version (x.Y.z) */
|
|
#define MR_VERSION_PATCH 9 /**< Patch version (x.y.Z) */
|
|
|
|
/**
|
|
* @brief Version hex.
|
|
*
|
|
* @note [23:16] major version, [15:8] minor version, [7:0] patch version, [31:24] reserved.
|
|
*/
|
|
#define MR_VERSION (MR_VERSION_MAJOR << 16 | MR_VERSION_MINOR << 8 | MR_VERSION_PATCH)
|
|
/** @} */
|
|
|
|
/**
|
|
* @addtogroup Compiler
|
|
* @{
|
|
*/
|
|
#if defined(__ARMCC_VERSION)
|
|
#define MR_SECTION(x) __attribute__((section(x))) /**< Section */
|
|
#define MR_USED __attribute__((used)) /**< Used */
|
|
#define MR_WEAK __attribute__((weak)) /**< Weak */
|
|
#define MR_INLINE static __inline /**< Inline */
|
|
typedef int ssize_t; /**< ssize_t type */
|
|
#elif defined (__IAR_SYSTEMS_ICC__)
|
|
#define MR_SECTION(x) @ x /**< Section */
|
|
#define MR_USED __root /**< Used */
|
|
#define MR_WEAK __weak /**< Weak */
|
|
#define MR_INLINE static inline /**< Inline */
|
|
#elif defined (__GNUC__)
|
|
#define MR_SECTION(x) __attribute__((section(x))) /**< Section */
|
|
#define MR_USED __attribute__((used)) /**< Used */
|
|
#define MR_WEAK __attribute__((weak)) /**< Weak */
|
|
#define MR_INLINE static __inline /**< Inline */
|
|
#elif defined (__ADSPBLACKFIN__)
|
|
#define MR_SECTION(x) __attribute__((section(x))) /**< Section */
|
|
#define MR_USED __attribute__((used)) /**< Used */
|
|
#define MR_WEAK __attribute__((weak)) /**< Weak */
|
|
#define MR_INLINE static inline /**< Inline */
|
|
#elif defined (_MSC_VER)
|
|
#define MR_SECTION(x) /**< Section */
|
|
#define MR_USED /**< Used */
|
|
#define MR_WEAK /**< Weak */
|
|
#define MR_INLINE static __inline /**< Inline */
|
|
#elif defined (__TASKING__)
|
|
#define MR_SECTION(x) __attribute__((section(x))) /**< Section */
|
|
#define MR_USED \
|
|
__attribute__((used, protect)) /**< Used */
|
|
#define MR_WEAK __attribute__((weak)) /**< Weak */
|
|
#define MR_INLINE static inline /**< Inline */
|
|
#else
|
|
#define MR_SECTION(x) __attribute__((section(x))) /**< Section */
|
|
#define MR_USED __attribute__((used)) /**< Used */
|
|
#define MR_WEAK __attribute__((weak)) /**< Weak */
|
|
#define MR_INLINE static __inline /**< Inline */
|
|
#endif /* __ARMCC_VERSION */
|
|
/** @} */
|
|
|
|
/**
|
|
* @addtogroup Auto-init
|
|
* @{
|
|
*/
|
|
typedef void (*mr_init_fn_t)(void); /**< Auto initialization function */
|
|
#define MR_INIT_EXPORT(fn, level) \
|
|
MR_USED const mr_init_fn_t _mr_auto_init_##fn MR_SECTION("mr_auto_init."level) = fn
|
|
#define MR_INIT_BOARD_EXPORT(fn) MR_INIT_EXPORT(fn, "1") /**< Exports a Board initialization function */
|
|
#define MR_INIT_DRV_EXPORT(fn) MR_INIT_EXPORT(fn, "2") /**< Exports a Driver initialization function */
|
|
#define MR_INIT_DEV_EXPORT(fn) MR_INIT_EXPORT(fn, "3") /**< Exports a Device initialization function */
|
|
#define MR_INIT_APP_EXPORT(fn) MR_INIT_EXPORT(fn, "4") /**< Exports an App initialization function */
|
|
/** @} */
|
|
|
|
/**
|
|
* @addtogroup Basic
|
|
* @{
|
|
*/
|
|
#define MR_NULL ((void *)0) /**< Null pointer */
|
|
#define MR_DISABLE (0) /**< Disable */
|
|
#define MR_ENABLE (1) /**< Enable */
|
|
#define MR_FALSE (0) /**< False */
|
|
#define MR_TRUE (1) /**< True */
|
|
/** @} */
|
|
|
|
/**
|
|
* @addtogroup Error
|
|
* @{
|
|
*/
|
|
#define MR_EOK (0) /**< No error */
|
|
#define MR_ENOMEM (-1) /**< No enough memory */
|
|
#define MR_EIO (-2) /**< I/O error */
|
|
#define MR_ENOTFOUND (-3) /**< Not found */
|
|
#define MR_EBUSY (-4) /**< Resource busy */
|
|
#define MR_EEXIST (-5) /**< Exists */
|
|
#define MR_ENOTSUP (-6) /**< Operation not supported */
|
|
#define MR_EINVAL (-7) /**< Invalid argument */
|
|
/** @} */
|
|
|
|
/**
|
|
* @addtogroup Memory
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Heap block structure.
|
|
*/
|
|
struct mr_heap_block
|
|
{
|
|
struct mr_heap_block *next; /**< Point to next block */
|
|
uint32_t size: 31; /**< Size of this block */
|
|
uint32_t allocated: 1; /**< Allocated flag */
|
|
};
|
|
/** @} */
|
|
|
|
/**
|
|
* @addtogroup List
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief List structure.
|
|
*/
|
|
struct mr_list
|
|
{
|
|
struct mr_list *next; /**< Point to next node */
|
|
struct mr_list *prev; /**< Point to prev node */
|
|
};
|
|
/** @} */
|
|
|
|
/**
|
|
* @addtogroup Ringbuffer
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Ring buffer structure.
|
|
*/
|
|
struct mr_ringbuf
|
|
{
|
|
uint8_t *buffer; /**< Buffer pool */
|
|
size_t size; /**< Buffer pool size */
|
|
uint32_t read_mirror: 1; /**< Read mirror flag */
|
|
uint32_t write_mirror: 1; /**< Write mirror flag */
|
|
uint32_t _reserved: 30; /**< Reserved */
|
|
size_t read_index; /**< Read index */
|
|
size_t write_index; /**< Write index */
|
|
};
|
|
/** @} */
|
|
|
|
/**
|
|
* @addtogroup AVL-tree
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief AVL tree structure.
|
|
*/
|
|
struct mr_avl
|
|
{
|
|
int height; /**< Balance factor */
|
|
uint32_t value; /**< Key-hold */
|
|
struct mr_avl *left_child; /**< Point to left-child node */
|
|
struct mr_avl *right_child; /**< Point to right-child node */
|
|
};
|
|
/** @} */
|
|
|
|
/**
|
|
* @addtogroup Device
|
|
* @{
|
|
*/
|
|
#define MR_MAGIC_NUMBER (0xdeadbeef) /**< Magic number */
|
|
|
|
#define MR_SYNC (0) /**< Synchronous */
|
|
#define MR_ASYNC (1) /**< Asynchronous */
|
|
|
|
/* [31:24] are for lock, [23:0] reserved */
|
|
#define MR_LOCK_RD (0x01 << 24) /**< Read lock */
|
|
#define MR_LOCK_WR (0x02 << 24) /**< Write lock */
|
|
#define MR_LOCK_RDWR (0x03 << 24) /**< Read/write lock */
|
|
#define MR_LOCK_NONBLOCK (0x04 << 24) /**< Non-blocking lock */
|
|
#define MR_LOCK_SLEEP (0x08 << 24) /**< Sleep lock */
|
|
|
|
/* [31:24] are for basic flags, [23:0] can define user flags */
|
|
#define MR_O_CLOSED (0) /**< Closed flag */
|
|
#define MR_O_QUERY (0) /**< Query flag */
|
|
#define MR_O_RDONLY (0x01 << 24) /**< Read only flag */
|
|
#define MR_O_WRONLY (0x02 << 24) /**< Write only flag */
|
|
#define MR_O_RDWR (0x03 << 24) /**< Read/write flag */
|
|
#define MR_O_NONBLOCK (0x04 << 24) /**< Non-blocking flag */
|
|
|
|
/* [31:24] are for basic commands, [23:0] can define user commands. (>0): user -> device, (<0): user <- device */
|
|
#define MR_IOC_SPOS (0x01 << 24) /**< Set position command */
|
|
#define MR_IOC_SRCB (0x02 << 24) /**< Set read callback command */
|
|
#define MR_IOC_SWCB (0x03 << 24) /**< Set write callback command */
|
|
#define MR_IOC_SCFG (0x04 << 24) /**< Set configuration command */
|
|
#define MR_IOC_SRBSZ (0x05 << 24) /**< Set read buffer size command */
|
|
#define MR_IOC_SWBSZ (0x06 << 24) /**< Set write buffer size command */
|
|
#define MR_IOC_CRBD (0x07 << 24) /**< Clear read buffer data command */
|
|
#define MR_IOC_CWBD (0x08 << 24) /**< Clear write buffer data command */
|
|
|
|
#define MR_IOC_GPOS (-(0x01 << 24)) /**< Get position command */
|
|
#define MR_IOC_GRCB (-(0x02 << 24)) /**< Get read callback command */
|
|
#define MR_IOC_GWCB (-(0x03 << 24)) /**< Get write callback command */
|
|
#define MR_IOC_GCFG (-(0x04 << 24)) /**< Get configuration command */
|
|
#define MR_IOC_GRBSZ (-(0x05 << 24)) /**< Get read buffer size command */
|
|
#define MR_IOC_GWBSZ (-(0x06 << 24)) /**< Get write buffer size command */
|
|
#define MR_IOC_GRBDSZ (-(0x07 << 24)) /**< Get read buffer data size command */
|
|
#define MR_IOC_GWBDSZ (-(0x08 << 24)) /**< Get write buffer data size command */
|
|
|
|
/* [31:24] are for interrupt flags, [23:0] can define user flags */
|
|
#define MR_ISR_RD (0x01 << 24) /**< Read interrupt */
|
|
#define MR_ISR_WR (0x02 << 24) /**< Write interrupt */
|
|
#define MR_ISR_MASK (0x7f << 24) /**< Interrupt mask */
|
|
|
|
/**
|
|
* @brief Driver structure.
|
|
*/
|
|
struct mr_drv
|
|
{
|
|
void *ops; /**< Operations */
|
|
void *data; /**< Data */
|
|
};
|
|
|
|
/**
|
|
* @brief Device types.
|
|
*/
|
|
enum mr_dev_type
|
|
{
|
|
MR_DEV_TYPE_ROOT = 0, /**< Root device */
|
|
MR_DEV_TYPE_ADC, /**< ADC device */
|
|
MR_DEV_TYPE_CAN, /**< CAN device */
|
|
MR_DEV_TYPE_DAC, /**< DAC device */
|
|
MR_DEV_TYPE_I2C, /**< I2C device */
|
|
MR_DEV_TYPE_PIN, /**< PIN device */
|
|
MR_DEV_TYPE_SERIAL, /**< Serial device */
|
|
MR_DEV_TYPE_SPI, /**< SPI device */
|
|
MR_DEV_TYPE_TIMER, /**< Timer device */
|
|
MR_DEV_TYPE_PWM, /**< PWM device */
|
|
MR_DEV_TYPE_COMPONENT, /**< Component device */
|
|
};
|
|
|
|
struct mr_dev;
|
|
|
|
/**
|
|
* @brief Device operations structure.
|
|
*/
|
|
struct mr_dev_ops
|
|
{
|
|
int (*open)(struct mr_dev *dev);
|
|
int (*close)(struct mr_dev *dev);
|
|
ssize_t (*read)(struct mr_dev *dev, void *buf, size_t count);
|
|
ssize_t (*write)(struct mr_dev *dev, const void *buf, size_t count);
|
|
int (*ioctl)(struct mr_dev *dev, int cmd, void *args);
|
|
ssize_t (*isr)(struct mr_dev *dev, int event, void *args);
|
|
};
|
|
|
|
/**
|
|
* @brief Device callback structure.
|
|
*/
|
|
struct mr_dev_call
|
|
{
|
|
void (*fn)(int desc, void *args);
|
|
struct mr_list list;
|
|
};
|
|
|
|
/**
|
|
* @brief Device structure.
|
|
*/
|
|
struct mr_dev
|
|
{
|
|
uint32_t magic; /**< Magic number */
|
|
#ifndef MR_CFG_DEV_NAME_LEN
|
|
#define MR_CFG_DEV_NAME_LEN (8)
|
|
#endif /* MR_CFG_DEV_NAME_LEN */
|
|
char name[MR_CFG_DEV_NAME_LEN]; /**< Name */
|
|
uint32_t type; /**< Type */
|
|
int flags; /**< Flags */
|
|
void *parent; /**< Parent device */
|
|
struct mr_list list; /**< Same level device list */
|
|
struct mr_list clist; /**< Child device list */
|
|
|
|
size_t ref_count; /**< Reference count */
|
|
#ifdef MR_USING_RDWR_CTL
|
|
volatile uint32_t lock; /**< Lock flags */
|
|
#endif /* MR_USING_RDWR_CTL */
|
|
int sync; /**< Sync flag */
|
|
int position; /**< Position */
|
|
|
|
struct mr_list rd_call_list; /**< Read callback list */
|
|
struct mr_list wr_call_list; /**< Write callback list */
|
|
|
|
const struct mr_dev_ops *ops; /**< Operations */
|
|
const struct mr_drv *drv; /**< Driver */
|
|
};
|
|
|
|
/**
|
|
* @brief Device descriptor structure.
|
|
*/
|
|
struct mr_dev_desc
|
|
{
|
|
struct mr_dev *dev; /**< Device */
|
|
int flags; /**< Open flags */
|
|
int position; /**< Current position */
|
|
struct mr_dev_call rd_call; /**< Read callback */
|
|
struct mr_dev_call wr_call; /**< Write callback */
|
|
};
|
|
/** @} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* _MR_DEF_H_ */
|