/*
 * Copyright (c) 2006-2021, RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Change Logs:
 * Date           Author       Notes
 * 2007-01-10     Bernard      the first version
 * 2008-07-12     Bernard      remove all rt_int8, rt_uint32_t etc typedef
 * 2010-10-26     yi.qiu       add module support
 * 2010-11-10     Bernard      add cleanup callback function in thread exit.
 * 2011-05-09     Bernard      use builtin va_arg in GCC 4.x
 * 2012-11-16     Bernard      change RT_NULL from ((void*)0) to 0.
 * 2012-12-29     Bernard      change the RT_USING_MEMPOOL location and add
 *                             RT_USING_MEMHEAP condition.
 * 2012-12-30     Bernard      add more control command for graphic.
 * 2013-01-09     Bernard      change version number.
 * 2015-02-01     Bernard      change version number to v2.1.0
 * 2017-08-31     Bernard      change version number to v3.0.0
 * 2017-11-30     Bernard      change version number to v3.0.1
 * 2017-12-27     Bernard      change version number to v3.0.2
 * 2018-02-24     Bernard      change version number to v3.0.3
 * 2018-04-25     Bernard      change version number to v3.0.4
 * 2018-05-31     Bernard      change version number to v3.1.0
 * 2018-09-04     Bernard      change version number to v3.1.1
 * 2018-09-14     Bernard      apply Apache License v2.0 to RT-Thread Kernel
 * 2018-12-28     armink       change version number to v3.1.2
 * 2019-03-14     armink       change version number to v3.1.3
 * 2019-06-12     armink       change version number to v3.1.4
 * 2020-05-14     armink       change version number to v3.1.5
 */

#ifndef __RT_DEF_H__
#define __RT_DEF_H__

/* include rtconfig header to import configuration */
#include <rtconfig.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @addtogroup BasicDef
 */

/*@{*/

/* RT-Thread version information */
#define RT_VERSION    3L /**< major version number */
#define RT_SUBVERSION 1L /**< minor version number */
#define RT_REVISION   5L /**< revise version number */

/* RT-Thread version */
#define RTTHREAD_VERSION ((RT_VERSION * 10000) + (RT_SUBVERSION * 100) + RT_REVISION)

/* RT-Thread basic data type definitions */
#ifndef RT_USING_ARCH_DATA_TYPE
typedef signed char    rt_int8_t;   /**<  8bit integer type */
typedef signed short   rt_int16_t;  /**< 16bit integer type */
typedef signed int     rt_int32_t;  /**< 32bit integer type */
typedef unsigned char  rt_uint8_t;  /**<  8bit unsigned integer type */
typedef unsigned short rt_uint16_t; /**< 16bit unsigned integer type */
typedef unsigned int   rt_uint32_t; /**< 32bit unsigned integer type */

#ifdef ARCH_CPU_64BIT
typedef signed long   rt_int64_t;  /**< 64bit integer type */
typedef unsigned long rt_uint64_t; /**< 64bit unsigned integer type */
#else
typedef signed long long   rt_int64_t;  /**< 64bit integer type */
typedef unsigned long long rt_uint64_t; /**< 64bit unsigned integer type */
#endif
#endif

typedef int           rt_bool_t;  /**< boolean type */
typedef long          rt_base_t;  /**< Nbit CPU related date type */
typedef unsigned long rt_ubase_t; /**< Nbit unsigned CPU related data type */

typedef rt_base_t   rt_err_t;     /**< Type for error number */
typedef rt_uint32_t rt_time_t;    /**< Type for time stamp */
typedef rt_uint32_t rt_tick_t;    /**< Type for tick count */
typedef rt_base_t   rt_flag_t;    /**< Type for flags */
typedef rt_ubase_t  rt_size_t;    /**< Type for size number */
typedef rt_ubase_t  rt_dev_t;     /**< Type for device */
typedef rt_base_t   rt_off_t;     /**< Type for offset */

/* boolean type definitions */
#define RT_TRUE  1 /**< boolean true  */
#define RT_FALSE 0 /**< boolean fails */

/**@}*/

/* maximum value of base type */
#define RT_UINT8_MAX  0xff          /**< Maxium number of UINT8 */
#define RT_UINT16_MAX 0xffff        /**< Maxium number of UINT16 */
#define RT_UINT32_MAX 0xffffffff    /**< Maxium number of UINT32 */
#define RT_TICK_MAX   RT_UINT32_MAX /**< Maxium number of tick */

/* maximum value of ipc type */
#define RT_SEM_VALUE_MAX   RT_UINT16_MAX /**< Maxium number of semaphore .value */
#define RT_MUTEX_VALUE_MAX RT_UINT16_MAX /**< Maxium number of mutex .value */
#define RT_MUTEX_HOLD_MAX  RT_UINT8_MAX  /**< Maxium number of mutex .hold */
#define RT_MB_ENTRY_MAX    RT_UINT16_MAX /**< Maxium number of mailbox .entry */
#define RT_MQ_ENTRY_MAX    RT_UINT16_MAX /**< Maxium number of message queue .entry */

#if defined(__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050)
#define __CLANG_ARM
#endif

/* Compiler Related Definitions */
#if defined(__CC_ARM) || defined(__CLANG_ARM) /* ARM Compiler */
#include <stdarg.h>
#define SECTION(x) __attribute__((section(x)))
#define RT_UNUSED  __attribute__((unused))
#define RT_USED    __attribute__((used))
#define ALIGN(n)   __attribute__((aligned(n)))

#define RT_WEAK   __attribute__((weak))
#define rt_inline static __inline

#elif defined(__IAR_SYSTEMS_ICC__) /* for IAR Compiler */
#include <stdarg.h>
#define SECTION(x) @x
#define RT_UNUSED
#define RT_USED   __root
#define PRAGMA(x) _Pragma(#x)
#define ALIGN(n)  PRAGMA(data_alignment = n)
#define RT_WEAK   __weak
#define rt_inline static inline

#elif defined(__GNUC__) /* GNU GCC Compiler */
#ifdef RT_USING_NEWLIB
#include <stdarg.h>
#else
/* the version of GNU GCC must be greater than 4.x */
typedef __builtin_va_list __gnuc_va_list;
typedef __gnuc_va_list    va_list;
#define va_start(v, l) __builtin_va_start(v, l)
#define va_end(v)      __builtin_va_end(v)
#define va_arg(v, l)   __builtin_va_arg(v, l)
#endif

#define SECTION(x) __attribute__((section(x)))
#define RT_UNUSED  __attribute__((unused))
#define RT_USED    __attribute__((used))
#define ALIGN(n)   __attribute__((aligned(n)))
#define RT_WEAK    __attribute__((weak))
#define rt_inline  static __inline
#elif defined(__ADSPBLACKFIN__) /* for VisualDSP++ Compiler */
#include <stdarg.h>
#define SECTION(x) __attribute__((section(x)))
#define RT_UNUSED  __attribute__((unused))
#define RT_USED    __attribute__((used))
#define ALIGN(n)   __attribute__((aligned(n)))
#define RT_WEAK    __attribute__((weak))
#define rt_inline  static inline
#elif defined(_MSC_VER)
#include <stdarg.h>
#define SECTION(x)
#define RT_UNUSED
#define RT_USED
#define ALIGN(n) __declspec(align(n))
#define RT_WEAK
#define rt_inline static __inline
#elif defined(__TI_COMPILER_VERSION__)
#include <stdarg.h>
/* The way that TI compiler set section is different from other(at least
     * GCC and MDK) compilers. See ARM Optimizing C/C++ Compiler 5.9.3 for more
     * details. */
#define SECTION(x)
#define RT_UNUSED
#define RT_USED
#define PRAGMA(x) _Pragma(#x)
#define ALIGN(n)
#define RT_WEAK
#define rt_inline static inline
#else
#error not supported tool chain
#endif

/* initialization export */
#ifdef RT_USING_COMPONENTS_INIT
typedef int (*init_fn_t)(void);
#ifdef _MSC_VER /* we do not support MS VC++ compiler */
#define INIT_EXPORT(fn, level)
#else
#if RT_DEBUG_INIT
struct rt_init_desc
{
    const char     *fn_name;
    const init_fn_t fn;
};
#define INIT_EXPORT(fn, level)                                                        \
    const char                        __rti_##fn##_name[] = #fn;                      \
    RT_USED const struct rt_init_desc __rt_init_desc_##fn SECTION(".rti_fn." level) = \
        {__rti_##fn##_name, fn};
#else
#define INIT_EXPORT(fn, level) \
    RT_USED const init_fn_t __rt_init_##fn SECTION(".rti_fn." level) = fn
#endif
#endif
#else
#define INIT_EXPORT(fn, level)
#endif

/* board init routines will be called in board_init() function */
#define INIT_BOARD_EXPORT(fn) INIT_EXPORT(fn, "1")

/* pre/device/component/env/app init routines will be called in init_thread */
/* components pre-initialization (pure software initilization) */
#define INIT_PREV_EXPORT(fn) INIT_EXPORT(fn, "2")
/* device initialization */
#define INIT_DEVICE_EXPORT(fn) INIT_EXPORT(fn, "3")
/* components initialization (dfs, lwip, ...) */
#define INIT_COMPONENT_EXPORT(fn) INIT_EXPORT(fn, "4")
/* environment initialization (mount disk, ...) */
#define INIT_ENV_EXPORT(fn) INIT_EXPORT(fn, "5")
/* appliation initialization (rtgui application etc ...) */
#define INIT_APP_EXPORT(fn) INIT_EXPORT(fn, "6")

#if !defined(RT_USING_FINSH)
/* define these to empty, even if not include finsh.h file */
#define FINSH_FUNCTION_EXPORT(name, desc)
#define FINSH_FUNCTION_EXPORT_ALIAS(name, alias, desc)
#define FINSH_VAR_EXPORT(name, type, desc)

#define MSH_CMD_EXPORT(command, desc)
#define MSH_CMD_EXPORT_ALIAS(command, alias, desc)
#elif !defined(FINSH_USING_SYMTAB)
#define FINSH_FUNCTION_EXPORT_CMD(name, cmd, desc)
#endif

/* event length */
#define RT_EVENT_LENGTH 32

/* memory management option */
#define RT_MM_PAGE_SIZE 4096
#define RT_MM_PAGE_MASK (RT_MM_PAGE_SIZE - 1)
#define RT_MM_PAGE_BITS 12

/* kernel malloc definitions */
#ifndef RT_KERNEL_MALLOC
#define RT_KERNEL_MALLOC(sz) rt_malloc(sz)
#endif

#ifndef RT_KERNEL_FREE
#define RT_KERNEL_FREE(ptr) rt_free(ptr)
#endif

#ifndef RT_KERNEL_REALLOC
#define RT_KERNEL_REALLOC(ptr, size) rt_realloc(ptr, size)
#endif

/**
 * @addtogroup Error
 */

/**@{*/

/* RT-Thread error code definitions */
#define RT_EOK      0  /**< There is no error */
#define RT_ERROR    1  /**< A generic error happens */
#define RT_ETIMEOUT 2  /**< Timed out */
#define RT_EFULL    3  /**< The resource is full */
#define RT_EEMPTY   4  /**< The resource is empty */
#define RT_ENOMEM   5  /**< No memory */
#define RT_ENOSYS   6  /**< No system */
#define RT_EBUSY    7  /**< Busy */
#define RT_EIO      8  /**< IO error */
#define RT_EINTR    9  /**< Interrupted system call */
#define RT_EINVAL   10 /**< Invalid argument */

/**@}*/

/**
 * @ingroup BasicDef
 *
 * @def RT_ALIGN(size, align)
 * Return the most contiguous size aligned at specified width. RT_ALIGN(13, 4)
 * would return 16.
 */
#define RT_ALIGN(size, align) (((size) + (align) - 1) & ~((align) - 1))

/**
 * @ingroup BasicDef
 *
 * @def RT_ALIGN_DOWN(size, align)
 * Return the down number of aligned at specified width. RT_ALIGN_DOWN(13, 4)
 * would return 12.
 */
#define RT_ALIGN_DOWN(size, align) ((size) & ~((align) - 1))

/**
 * @ingroup BasicDef
 *
 * @def RT_NULL
 * Similar as the \c NULL in C library.
 */
#define RT_NULL (0)

/**
 * Double List structure
 */
struct rt_list_node
{
    struct rt_list_node *next;         /**< point to next node. */
    struct rt_list_node *prev;         /**< point to prev node. */
};
typedef struct rt_list_node rt_list_t; /**< Type for lists. */

/**
 * Single List structure
 */
struct rt_slist_node
{
    struct rt_slist_node *next;          /**< point to next node. */
};
typedef struct rt_slist_node rt_slist_t; /**< Type for single list. */

/**
 * @addtogroup KernelObject
 */

/**@{*/

/*
 * kernel object macros
 */

/**
 * Base structure of Kernel object
 */
struct rt_object
{
    char       name[RT_NAME_MAX];      /**< name of kernel object */
    rt_uint8_t type;                   /**< type of kernel object */
    rt_uint8_t flag;                   /**< flag of kernel object */

    rt_list_t list;                    /**< list node of kernel object */
};
typedef struct rt_object *rt_object_t; /**< Type for kernel objects. */

/**
 *  The object type can be one of the follows with specific
 *  macros enabled:
 *  - Thread
 *  - Semaphore
 *  - Mutex
 *  - Event
 *  - MailBox
 *  - MessageQueue
 *  - MemHeap
 *  - MemPool
 *  - Device
 *  - Timer
 *  - Unknown
 *  - Static
 */
enum rt_object_class_type
{
    RT_Object_Class_Null         = 0x00, /**< The object is not used. */
    RT_Object_Class_Thread       = 0x01, /**< The object is a thread. */
    RT_Object_Class_Semaphore    = 0x02, /**< The object is a semaphore. */
    RT_Object_Class_Mutex        = 0x03, /**< The object is a mutex. */
    RT_Object_Class_Event        = 0x04, /**< The object is a event. */
    RT_Object_Class_MailBox      = 0x05, /**< The object is a mail box. */
    RT_Object_Class_MessageQueue = 0x06, /**< The object is a message queue. */
    RT_Object_Class_MemHeap      = 0x07, /**< The object is a memory heap. */
    RT_Object_Class_MemPool      = 0x08, /**< The object is a memory pool. */
    RT_Object_Class_Device       = 0x09, /**< The object is a device. */
    RT_Object_Class_Timer        = 0x0a, /**< The object is a timer. */
    RT_Object_Class_Unknown      = 0x0c, /**< The object is unknown. */
    RT_Object_Class_Static       = 0x80  /**< The object is a static object. */
};

/**
 * The information of the kernel object
 */
struct rt_object_information
{
    enum rt_object_class_type type;        /**< object class type */
    rt_list_t                 object_list; /**< object list */
    rt_size_t                 object_size; /**< object size */
};

/**
 * The hook function call macro
 */
#ifdef RT_USING_HOOK
#define RT_OBJECT_HOOK_CALL(func, argv)   \
    do {                                  \
        if ((func) != RT_NULL) func argv; \
    } while (0)
#else
#define RT_OBJECT_HOOK_CALL(func, argv)
#endif

/**@}*/

/**
 * @addtogroup Clock
 */

/**@{*/

/**
 * clock & timer macros
 */
#define RT_TIMER_FLAG_DEACTIVATED 0x0  /**< timer is deactive */
#define RT_TIMER_FLAG_ACTIVATED   0x1  /**< timer is active */
#define RT_TIMER_FLAG_ONE_SHOT    0x0  /**< one shot timer */
#define RT_TIMER_FLAG_PERIODIC    0x2  /**< periodic timer */

#define RT_TIMER_FLAG_HARD_TIMER 0x0   /**< hard timer,the timer's callback function will be called in tick isr. */
#define RT_TIMER_FLAG_SOFT_TIMER 0x4   /**< soft timer,the timer's callback function will be called in timer thread. */

#define RT_TIMER_CTRL_SET_TIME     0x0 /**< set timer control command */
#define RT_TIMER_CTRL_GET_TIME     0x1 /**< get timer control command */
#define RT_TIMER_CTRL_SET_ONESHOT  0x2 /**< change timer to one shot */
#define RT_TIMER_CTRL_SET_PERIODIC 0x3 /**< change timer to periodic */
#define RT_TIMER_CTRL_GET_STATE    0x4 /**< get timer run state active or deactive*/

#ifndef RT_TIMER_SKIP_LIST_LEVEL
#define RT_TIMER_SKIP_LIST_LEVEL 1
#endif

/* 1 or 3 */
#ifndef RT_TIMER_SKIP_LIST_MASK
#define RT_TIMER_SKIP_LIST_MASK 0x3
#endif

/**
 * timer structure
 */
struct rt_timer
{
    struct rt_object parent; /**< inherit from rt_object */

    rt_list_t row[RT_TIMER_SKIP_LIST_LEVEL];

    void (*timeout_func)(void *parameter); /**< timeout function */
    void *parameter;                       /**< timeout function's parameter */

    rt_tick_t init_tick;                   /**< timer timeout tick */
    rt_tick_t timeout_tick;                /**< timeout tick */
};
typedef struct rt_timer *rt_timer_t;

/**@}*/

/**
 * @addtogroup Thread
 */

/**@{*/

/*
 * Thread
 */

/*
 * thread state definitions
 */
#define RT_THREAD_INIT      0x00              /**< Initialized status */
#define RT_THREAD_READY     0x01              /**< Ready status */
#define RT_THREAD_SUSPEND   0x02              /**< Suspend status */
#define RT_THREAD_RUNNING   0x03              /**< Running status */
#define RT_THREAD_BLOCK     RT_THREAD_SUSPEND /**< Blocked status */
#define RT_THREAD_CLOSE     0x04              /**< Closed status */
#define RT_THREAD_STAT_MASK 0x0f

/**
 * thread control command definitions
 */
#define RT_THREAD_CTRL_STARTUP         0x00 /**< Startup thread. */
#define RT_THREAD_CTRL_CLOSE           0x01 /**< Close thread. */
#define RT_THREAD_CTRL_CHANGE_PRIORITY 0x02 /**< Change thread priority. */
#define RT_THREAD_CTRL_INFO            0x03 /**< Get thread information. */

/**
 * Thread structure
 */
struct rt_thread
{
    /* rt object */
    char       name[RT_NAME_MAX]; /**< the name of thread */
    rt_uint8_t type;              /**< type of object */
    rt_uint8_t flags;             /**< thread's flags */

    rt_list_t list;               /**< the object list */
    rt_list_t tlist;              /**< the thread list */

    /* stack point and entry */
    void       *sp;         /**< stack point */
    void       *entry;      /**< entry */
    void       *parameter;  /**< parameter */
    void       *stack_addr; /**< stack address */
    rt_uint32_t stack_size; /**< stack size */

    /* error code */
    rt_err_t error;  /**< error code */

    rt_uint8_t stat; /**< thread status */

    /* priority */
    rt_uint8_t current_priority; /**< current priority */
    rt_uint8_t init_priority;    /**< initialized priority */
#if RT_THREAD_PRIORITY_MAX > 32
    rt_uint8_t number;
    rt_uint8_t high_mask;
#endif
    rt_uint32_t number_mask;

#if defined(RT_USING_EVENT)
    /* thread event */
    rt_uint32_t event_set;
    rt_uint8_t  event_info;
#endif

    rt_ubase_t init_tick;                   /**< thread's initialized tick */
    rt_ubase_t remaining_tick;              /**< remaining tick */

    struct rt_timer thread_timer;           /**< built-in thread timer */

    void (*cleanup)(struct rt_thread *tid); /**< cleanup function when thread exit */

    rt_uint32_t user_data;                  /**< private user data beyond this thread */
};
typedef struct rt_thread *rt_thread_t;

/**@}*/

/**
 * @addtogroup IPC
 */

/**@{*/

/**
 * IPC flags and control command definitions
 */
#define RT_IPC_FLAG_FIFO 0x00   /**< FIFOed IPC. @ref IPC. */
#define RT_IPC_FLAG_PRIO 0x01   /**< PRIOed IPC. @ref IPC. */

#define RT_IPC_CMD_UNKNOWN 0x00 /**< unknown IPC command */
#define RT_IPC_CMD_RESET   0x01 /**< reset IPC object */

#define RT_WAITING_FOREVER -1   /**< Block forever until get resource. */
#define RT_WAITING_NO      0    /**< Non-block. */

/**
 * Base structure of IPC object
 */
struct rt_ipc_object
{
    struct rt_object parent;  /**< inherit from rt_object */

    rt_list_t suspend_thread; /**< threads pended on this resource */
};

#ifdef RT_USING_SEMAPHORE
/**
 * Semaphore structure
 */
struct rt_semaphore
{
    struct rt_ipc_object parent; /**< inherit from ipc_object */

    rt_uint16_t value;           /**< value of semaphore. */
    rt_uint16_t reserved;        /**< reserved field */
};
typedef struct rt_semaphore *rt_sem_t;
#endif

#ifdef RT_USING_MUTEX
/**
 * Mutual exclusion (mutex) structure
 */
struct rt_mutex
{
    struct rt_ipc_object parent;  /**< inherit from ipc_object */

    rt_uint16_t value;            /**< value of mutex */

    rt_uint8_t original_priority; /**< priority of last thread hold the mutex */
    rt_uint8_t hold;              /**< numbers of thread hold the mutex */

    struct rt_thread *owner;      /**< current owner of mutex */
};
typedef struct rt_mutex *rt_mutex_t;
#endif

#ifdef RT_USING_EVENT
/**
 * flag defintions in event
 */
#define RT_EVENT_FLAG_AND   0x01 /**< logic and */
#define RT_EVENT_FLAG_OR    0x02 /**< logic or */
#define RT_EVENT_FLAG_CLEAR 0x04 /**< clear flag */

/*
 * event structure
 */
struct rt_event
{
    struct rt_ipc_object parent; /**< inherit from ipc_object */

    rt_uint32_t set;             /**< event set */
};
typedef struct rt_event *rt_event_t;
#endif

#ifdef RT_USING_MAILBOX
/**
 * mailbox structure
 */
struct rt_mailbox
{
    struct rt_ipc_object parent;     /**< inherit from ipc_object */

    rt_ubase_t *msg_pool;            /**< start address of message buffer */

    rt_uint16_t size;                /**< size of message pool */

    rt_uint16_t entry;               /**< index of messages in msg_pool */
    rt_uint16_t in_offset;           /**< input offset of the message buffer */
    rt_uint16_t out_offset;          /**< output offset of the message buffer */

    rt_list_t suspend_sender_thread; /**< sender thread suspended on this mailbox */
};
typedef struct rt_mailbox *rt_mailbox_t;
#endif

#ifdef RT_USING_MESSAGEQUEUE
/**
 * message queue structure
 */
struct rt_messagequeue
{
    struct rt_ipc_object parent;     /**< inherit from ipc_object */

    void *msg_pool;                  /**< start address of message queue */

    rt_uint16_t msg_size;            /**< message size of each message */
    rt_uint16_t max_msgs;            /**< max number of messages */

    rt_uint16_t entry;               /**< index of messages in the queue */

    void *msg_queue_head;            /**< list head */
    void *msg_queue_tail;            /**< list tail */
    void *msg_queue_free;            /**< pointer indicated the free node of queue */

    rt_list_t suspend_sender_thread; /**< sender thread suspended on this message queue */
};
typedef struct rt_messagequeue *rt_mq_t;
#endif

/**@}*/

/**
 * @addtogroup MM
 */

/**@{*/

/*
 * memory management
 * heap & partition
 */

#ifdef RT_USING_MEMHEAP
/**
 * memory item on the heap
 */
struct rt_memheap_item
{
    rt_uint32_t        magic;          /**< magic number for memheap */
    struct rt_memheap *pool_ptr;       /**< point of pool */

    struct rt_memheap_item *next;      /**< next memheap item */
    struct rt_memheap_item *prev;      /**< prev memheap item */

    struct rt_memheap_item *next_free; /**< next free memheap item */
    struct rt_memheap_item *prev_free; /**< prev free memheap item */
};

/**
 * Base structure of memory heap object
 */
struct rt_memheap
{
    struct rt_object parent;             /**< inherit from rt_object */

    void *start_addr;                    /**< pool start address and size */

    rt_uint32_t pool_size;               /**< pool size */
    rt_uint32_t available_size;          /**< available size */
    rt_uint32_t max_used_size;           /**< maximum allocated size */

    struct rt_memheap_item *block_list;  /**< used block list */

    struct rt_memheap_item *free_list;   /**< free block list */
    struct rt_memheap_item  free_header; /**< free block list header */

    struct rt_semaphore lock;            /**< semaphore lock */
};
#endif

#ifdef RT_USING_MEMPOOL
/**
 * Base structure of Memory pool object
 */
struct rt_mempool
{
    struct rt_object parent;     /**< inherit from rt_object */

    void     *start_address;     /**< memory pool start */
    rt_size_t size;              /**< size of memory pool */

    rt_size_t   block_size;      /**< size of memory blocks */
    rt_uint8_t *block_list;      /**< memory blocks list */

    rt_size_t block_total_count; /**< numbers of memory block */
    rt_size_t block_free_count;  /**< numbers of free memory block */

    rt_list_t suspend_thread;    /**< threads pended on this resource */
};
typedef struct rt_mempool *rt_mp_t;
#endif

/**@}*/

#ifdef RT_USING_DEVICE
/**
 * @addtogroup Device
 */

/**@{*/

/**
 * device (I/O) class type
 */
enum rt_device_class_type
{
    RT_Device_Class_Char = 0,      /**< character device */
    RT_Device_Class_Block,         /**< block device */
    RT_Device_Class_NetIf,         /**< net interface */
    RT_Device_Class_MTD,           /**< memory device */
    RT_Device_Class_CAN,           /**< CAN device */
    RT_Device_Class_RTC,           /**< RTC device */
    RT_Device_Class_Sound,         /**< Sound device */
    RT_Device_Class_Graphic,       /**< Graphic device */
    RT_Device_Class_I2CBUS,        /**< I2C bus device */
    RT_Device_Class_USBDevice,     /**< USB slave device */
    RT_Device_Class_USBHost,       /**< USB host bus */
    RT_Device_Class_SPIBUS,        /**< SPI bus device */
    RT_Device_Class_SPIDevice,     /**< SPI device */
    RT_Device_Class_SDIO,          /**< SDIO bus device */
    RT_Device_Class_PM,            /**< PM pseudo device */
    RT_Device_Class_Pipe,          /**< Pipe device */
    RT_Device_Class_Portal,        /**< Portal device */
    RT_Device_Class_Timer,         /**< Timer device */
    RT_Device_Class_Miscellaneous, /**< Miscellaneous device */
    RT_Device_Class_Sensor,        /**< Sensor device */
    RT_Device_Class_Touch,         /**< Touch device */
    RT_Device_Class_Unknown        /**< unknown device */
};

/**
 * device flags defitions
 */
#define RT_DEVICE_FLAG_DEACTIVATE 0x000 /**< device is not not initialized */

#define RT_DEVICE_FLAG_RDONLY 0x001     /**< read only */
#define RT_DEVICE_FLAG_WRONLY 0x002     /**< write only */
#define RT_DEVICE_FLAG_RDWR   0x003     /**< read and write */

#define RT_DEVICE_FLAG_REMOVABLE  0x004 /**< removable device */
#define RT_DEVICE_FLAG_STANDALONE 0x008 /**< standalone device */
#define RT_DEVICE_FLAG_ACTIVATED  0x010 /**< device is activated */
#define RT_DEVICE_FLAG_SUSPENDED  0x020 /**< device is suspended */
#define RT_DEVICE_FLAG_STREAM     0x040 /**< stream mode */

#define RT_DEVICE_FLAG_INT_RX 0x100     /**< INT mode on Rx */
#define RT_DEVICE_FLAG_DMA_RX 0x200     /**< DMA mode on Rx */
#define RT_DEVICE_FLAG_INT_TX 0x400     /**< INT mode on Tx */
#define RT_DEVICE_FLAG_DMA_TX 0x800     /**< DMA mode on Tx */

#define RT_DEVICE_OFLAG_CLOSE  0x000    /**< device is closed */
#define RT_DEVICE_OFLAG_RDONLY 0x001    /**< read only access */
#define RT_DEVICE_OFLAG_WRONLY 0x002    /**< write only access */
#define RT_DEVICE_OFLAG_RDWR   0x003    /**< read and write */
#define RT_DEVICE_OFLAG_OPEN   0x008    /**< device is opened */
#define RT_DEVICE_OFLAG_MASK   0xf0f    /**< mask of open flag */

/**
 * general device commands
 */
#define RT_DEVICE_CTRL_RESUME  0x01 /**< resume device */
#define RT_DEVICE_CTRL_SUSPEND 0x02 /**< suspend device */
#define RT_DEVICE_CTRL_CONFIG  0x03 /**< configure device */
#define RT_DEVICE_CTRL_CLOSE   0x04 /**< close device */

#define RT_DEVICE_CTRL_SET_INT 0x10 /**< set interrupt */
#define RT_DEVICE_CTRL_CLR_INT 0x11 /**< clear interrupt */
#define RT_DEVICE_CTRL_GET_INT 0x12 /**< get interrupt status */

typedef struct rt_device *rt_device_t;
/**
 * operations set for device object
 */
struct rt_device_ops
{
    /* common device interface */
    rt_err_t (*init)(rt_device_t dev);
    rt_err_t (*open)(rt_device_t dev, rt_uint16_t oflag);
    rt_err_t (*close)(rt_device_t dev);
    rt_size_t (*read)(rt_device_t dev, rt_off_t pos, void *buffer, rt_size_t size);
    rt_size_t (*write)(rt_device_t dev, rt_off_t pos, const void *buffer, rt_size_t size);
    rt_err_t (*control)(rt_device_t dev, int cmd, void *args);
};

/**
 * Device structure
 */
struct rt_device
{
    struct rt_object parent;             /**< inherit from rt_object */

    enum rt_device_class_type type;      /**< device type */
    rt_uint16_t               flag;      /**< device flag */
    rt_uint16_t               open_flag; /**< device open flag */

    rt_uint8_t ref_count;                /**< reference count */
    rt_uint8_t device_id;                /**< 0 - 255 */

    /* device call back */
    rt_err_t (*rx_indicate)(rt_device_t dev, rt_size_t size);
    rt_err_t (*tx_complete)(rt_device_t dev, void *buffer);

#ifdef RT_USING_DEVICE_OPS
    const struct rt_device_ops *ops;
#else
    /* common device interface */
    rt_err_t (*init)(rt_device_t dev);
    rt_err_t (*open)(rt_device_t dev, rt_uint16_t oflag);
    rt_err_t (*close)(rt_device_t dev);
    rt_size_t (*read)(rt_device_t dev, rt_off_t pos, void *buffer, rt_size_t size);
    rt_size_t (*write)(rt_device_t dev, rt_off_t pos, const void *buffer, rt_size_t size);
    rt_err_t (*control)(rt_device_t dev, int cmd, void *args);
#endif

    void *user_data; /**< device private data */
};

/**@}*/
#endif

#ifdef __cplusplus
}
#endif

#ifdef __cplusplus
/* RT-Thread definitions for C++ */
namespace rtthread
{

enum TICK_WAIT
{
    WAIT_NONE    = 0,
    WAIT_FOREVER = -1,
};

} // namespace rtthread

#endif /* end of __cplusplus */

#endif
