rtdef.h 20.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
/*
 * File      : rtdef.h
 * This file is part of RT-Thread RTOS
 * COPYRIGHT (C) 2006, RT-Thread Development Team
 *
 * The license and distribution terms for this file may be
 * found in the file LICENSE in this distribution or at
 * http://openlab.rt-thread.com/license/LICENSE.
 *
 * Change Logs:
 * Date           Author       Notes
 * 2007-01-10     Bernard      the first version
13
 * 2008-07-12     Bernard	   remove all rt_int8, rt_uint32_t etc typedef
qiuyiuestc's avatar
qiuyiuestc 已提交
14
 * 2010-10-26     yi.qiu       add module support
15
 * 2010-11-10     Bernard      add cleanup callback function in thread exit.
16 17 18 19 20 21 22 23 24 25
 */
#ifndef __RT_DEF_H__
#define __RT_DEF_H__

#include <rtconfig.h>

#ifdef __cplusplus
extern "C" {
#endif

B
bernard.xiong@gmail.com 已提交
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
/**
 * @addtogroup BasicDef
 */
/*@{*/

/**
 * RT-Thread version information
 */
#define RT_VERSION						4L		/**< major version number */
#define RT_SUBVERSION					0L		/**< minor version number */

/**
 * RT-Thread basic data type definitions
 */
typedef signed 	 char  					rt_int8_t;		/**<  8bit integer type */
typedef signed 	 short 					rt_int16_t;		/**< 16bit integer type */
typedef signed 	 long  					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 long  					rt_uint32_t;	/**< 32bit unsigned integer type */
typedef int 							rt_bool_t;		/**< boolean type */
47 48

/* 32bit CPU */
B
bernard.xiong@gmail.com 已提交
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
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_uint32_t						rt_off_t;		/**< Type for offset			*/

/**
 * boolean type definitions
 */
#define RT_TRUE 						1	/**< boolean true  */
#define RT_FALSE 						0	/**< boolean fails */
/*@}*/
66 67 68 69 70

/* maximun 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.					*/
71
#define RT_TICK_MAX						RT_UINT32_MAX	/* Maxium number of tick                    */
72

B
bernard.xiong 已提交
73
/* Compiler Related Definitions */
74
#ifdef __CC_ARM                			 /* ARM Compiler 	*/
75
    #include <stdarg.h>
76 77
    #define SECTION(x)  				__attribute__((section(x)))
    #define UNUSED  					__attribute__((unused))
B
bernard.xiong 已提交
78
	#define ALIGN(n)					__attribute__((aligned(n)))
79
    #define rt_inline   				static __inline
B
bernard.xiong 已提交
80 81 82 83 84 85
	/* module compiling */
	#ifdef RT_USING_MODULE
		#define RTT_API	__declspec(dllimport)
	#else
		#define RTT_API __declspec(dllexport)
	#endif
86

87
#elif defined (__IAR_SYSTEMS_ICC__)        		/* for IAR Compiler */
88
    #include <stdarg.h>
89
    #define SECTION(x)  				@ x
90
    #define UNUSED
91 92
	#define PRAGMA(x)					_Pragma(#x)
	#define ALIGN(n)					PRAGMA(data_alignment=n)
93
    #define rt_inline 					inline
B
bernard.xiong 已提交
94
	#define RTT_API
95

96
#elif defined (__GNUC__)        		/* GNU GCC Compiler */
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
    #ifdef RT_USING_NEWLIB
        #include <stdarg.h>
    #else
        typedef void *__sys_va_list;
        typedef __sys_va_list va_list;
        #define __va_rounded_size(type)	\
            (((sizeof (type) + sizeof (int) - 1) / sizeof (int)) * sizeof (int))
        #define va_start(ap, lastarg)	\
            (ap = ((char *) &(lastarg) + __va_rounded_size(lastarg)))
        #define va_end(ap)	((void)0)
        /*	little endian */
        #define va_arg(ap, type)	\
            (ap = (__sys_va_list) ((char *) (ap) + __va_rounded_size (type)),  \
            *((type *) (void *) ((char *) (ap) - __va_rounded_size (type))))
    #endif

113 114
    #define SECTION(x) 					__attribute__((section(x)))
    #define UNUSED 						__attribute__((unused))
B
bernard.xiong 已提交
115
	#define ALIGN(n)					__attribute__((aligned(n)))
116
    #define rt_inline 					static __inline
B
bernard.xiong 已提交
117
	#define RTT_API
118 119
#endif

120 121
/* event length 			*/
#define RT_EVENT_LENGTH					32
122 123

/* memory management option */
124 125 126
#define RT_MM_PAGE_SIZE					4096
#define RT_MM_PAGE_MASK 				(RT_MM_PAGE_SIZE - 1)
#define RT_MM_PAGE_BITS					12
127 128 129 130 131

/**
 * @addtogroup Error
 */
/*@{*/
B
bernard.xiong@gmail.com 已提交
132 133 134 135 136 137 138 139 140
/** 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								*/
141 142 143
/*@}*/

#ifdef RT_DEBUG
144 145
#define RT_ASSERT(EX)					if (!(EX)) {volatile char dummy=0; rt_kprintf("(%s) assert failed at %s:%d \n", \
										#EX, __FUNCTION__, __LINE__); while (dummy==0);}
146 147 148 149 150
#else
#define RT_ASSERT(EX)
#endif

/**
B
bernard.xiong@gmail.com 已提交
151 152
 * @ingroup BasicDef
 *
153 154
 * @def RT_ALIGN(size, align)
 * Return the most contiguous size aligned at specified width. RT_ALIGN(13, 4)
155
 * would return 16.
B
bernard.xiong@gmail.com 已提交
156 157 158 159
 */
#define RT_ALIGN(size, align)			(((size) + (align) - 1) & ~((align)-1))
/**
 * @ingroup BasicDef
160 161 162 163
 *
 * @def RT_ALIGN_DOWN(size, align)
 * Return the down number of aligned at specified width. RT_ALIGN_DOWN(13, 4)
 * would return 12. 
164
 */
165
#define RT_ALIGN_DOWN(size, align)		((size) & ~((align) -1))
166 167

/**
B
bernard.xiong@gmail.com 已提交
168 169
 * @ingroup BasicDef
 *
170 171 172
 * @def RT_NULL
 * Similar as the \c NULL in C library.
 */
173
#define RT_NULL 						((void *)0)
174 175 176

struct rt_list_node
{
177 178
	struct rt_list_node 				*next;			/* point to next node. 						*/
	struct rt_list_node 				*prev;			/* point to prev node. 						*/
179
};
180
typedef struct rt_list_node rt_list_t;					/* Type for lists. 							*/
181 182 183 184 185

/**
 * @addtogroup KernelObject
 */
/*@{*/
qiuyiuestc's avatar
qiuyiuestc 已提交
186 187 188 189 190 191

/*
 * kernel object macros
 */
#define RT_OBJECT_FLAG_MODULE		0x80			/* is module object. 						*/

B
bernard.xiong@gmail.com 已提交
192
/**
193 194 195 196
 * Base structure of Kernel object
 */
struct rt_object
{
B
bernard.xiong@gmail.com 已提交
197 198 199
	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					*/
qiuyiuestc's avatar
qiuyiuestc 已提交
200

B
bernard.xiong@gmail.com 已提交
201 202 203 204
#ifdef RT_USING_MODULE
	void* module_id;									/**< id of application module				*/
#endif
	rt_list_t	list;									/**< list node of kernel object 			*/
205
};
206
typedef struct rt_object* rt_object_t;					/* Type for kernel objects. 				*/
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224

/**
 *	The object type can be one of the follows with specific
 *	macros enabled:
 *	- Thread
 *	- Semaphore
 *	- Mutex
 *	- Event
 *	- MailBox
 *	- MessageQueue
 *	- MemPool
 *  - Device
 *	- Timer
 *	- Unknown
 *	- Static
 */
enum rt_object_class_type
{
B
bernard.xiong@gmail.com 已提交
225
	RT_Object_Class_Thread = 0,							/**< The object is a thread. 				*/
226
#ifdef RT_USING_SEMAPHORE
B
bernard.xiong@gmail.com 已提交
227
	RT_Object_Class_Semaphore,							/**< The object is a semaphore. 			*/
228 229
#endif
#ifdef RT_USING_MUTEX
B
bernard.xiong@gmail.com 已提交
230
	RT_Object_Class_Mutex,								/**< The object is a mutex. 				*/
231 232
#endif
#ifdef RT_USING_EVENT
B
bernard.xiong@gmail.com 已提交
233
	RT_Object_Class_Event,								/**< The object is a event. 				*/
234 235
#endif
#ifdef RT_USING_MAILBOX
B
bernard.xiong@gmail.com 已提交
236
	RT_Object_Class_MailBox,							/**< The object is a mail box. 				*/
237 238
#endif
#ifdef RT_USING_MESSAGEQUEUE
B
bernard.xiong@gmail.com 已提交
239
	RT_Object_Class_MessageQueue,						/**< The object is a message queue. 		*/
240 241
#endif
#ifdef RT_USING_MEMPOOL
B
bernard.xiong@gmail.com 已提交
242
	RT_Object_Class_MemPool,							/**< The object is a memory pool. 			*/
243 244
#endif
#ifdef RT_USING_DEVICE
B
bernard.xiong@gmail.com 已提交
245
	RT_Object_Class_Device,								/**< The object is a device 				*/
246
#endif
B
bernard.xiong@gmail.com 已提交
247
	RT_Object_Class_Timer,								/**< The object is a timer. 				*/
248
#ifdef RT_USING_MODULE
B
bernard.xiong@gmail.com 已提交
249
	RT_Object_Class_Module,								/**< The object is a module. 				*/
250
#endif
B
bernard.xiong@gmail.com 已提交
251 252
	RT_Object_Class_Unknown,							/**< The object is unknown. 				*/
	RT_Object_Class_Static = 0x80						/**< The object is a static object. 		*/
253
};
254

B
bernard.xiong@gmail.com 已提交
255 256
/**
 * The information of the kernel object
257 258 259
 */
struct rt_object_information
{
B
bernard.xiong@gmail.com 已提交
260 261 262
	enum rt_object_class_type type;						/**< object class type 						*/
	rt_list_t object_list;								/**< object list 							*/
	rt_size_t object_size;								/**< object size 							*/
263 264 265 266 267 268 269 270
};
/*@}*/

/**
 * @addtogroup Clock
 */
/*@{*/

B
bernard.xiong@gmail.com 已提交
271
/**
272 273
 * clock & timer macros
 */
B
bernard.xiong@gmail.com 已提交
274 275 276 277
#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 						*/
278

B
bernard.xiong@gmail.com 已提交
279 280
#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. */
281

B
bernard.xiong@gmail.com 已提交
282 283 284 285
#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 				*/
286

B
bernard.xiong@gmail.com 已提交
287
/**
288 289 290 291
 * timer structure
 */
struct rt_timer
{
B
bernard.xiong@gmail.com 已提交
292
	struct rt_object parent;							/**< inherit from rt_object 				*/
293

B
bernard.xiong@gmail.com 已提交
294
	rt_list_t list;										/**< the node of timer list 				*/
295

B
bernard.xiong@gmail.com 已提交
296 297
	void (*timeout_func)(void* parameter);				/**< timeout function 						*/
	void *parameter;									/**< timeout function's parameter 			*/
298

B
bernard.xiong@gmail.com 已提交
299 300
	rt_tick_t init_tick;								/**< timer timeout tick						*/
	rt_tick_t timeout_tick;								/**< timeout tick 							*/
301 302 303 304 305 306 307 308 309 310 311 312 313
};
typedef struct rt_timer* rt_timer_t;
/*@}*/

/**
 * @addtogroup Thread
 */
/*@{*/

/*
 * Thread
 */

B
bernard.xiong@gmail.com 已提交
314 315 316 317 318 319 320 321 322
/*
 * 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						*/
323

B
bernard.xiong@gmail.com 已提交
324 325 326 327 328 329 330
/**
 * thread control command definitions
 */
#define RT_THREAD_CTRL_STARTUP			0x00				/**< Starup 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. 			*/
331 332 333

typedef struct rt_thread* rt_thread_t;

B
bernard.xiong@gmail.com 已提交
334 335 336
/**
 * Thread structure
 *
337 338 339 340
 */
struct rt_thread
{
	/* rt object */
B
bernard.xiong@gmail.com 已提交
341 342 343
	char        name[RT_NAME_MAX];						/**< the name of thread 					*/
	rt_uint8_t	type;									/**< type of object 						*/
	rt_uint8_t  flags;									/**< thread's flags 						*/
qiuyiuestc's avatar
qiuyiuestc 已提交
344 345
	
#ifdef RT_USING_MODULE
B
bernard.xiong@gmail.com 已提交
346
	void* 		module_id;								/**< id of application module				*/
qiuyiuestc's avatar
qiuyiuestc 已提交
347
#endif
348

B
bernard.xiong@gmail.com 已提交
349 350
	rt_list_t	list;									/**< the object list 						*/
	rt_list_t	tlist;									/**< the thread list 						*/
351 352

	/* stack point and entry */
B
bernard.xiong@gmail.com 已提交
353 354 355 356 357
	void*		sp;										/**< stack point 							*/
	void*		entry;									/**< entry 									*/
	void*       parameter;								/**< parameter 								*/
	void*       stack_addr;								/**< stack address 							*/
	rt_uint16_t stack_size;								/**< stack size 							*/
358 359

	/* error code */
B
bernard.xiong@gmail.com 已提交
360
	rt_err_t    error;									/**< error code 							*/
361

B
bernard.xiong@gmail.com 已提交
362
	rt_uint8_t	stat;									/**< thread stat 							*/
363

364
	/* priority */
B
bernard.xiong@gmail.com 已提交
365 366
	rt_uint8_t	current_priority;						/**< current priority 						*/
	rt_uint8_t	init_priority;							/**< initialized priority 					*/
367 368 369 370 371 372
#if RT_THREAD_PRIORITY_MAX > 32
	rt_uint8_t 	number;
	rt_uint8_t	high_mask;
#endif
	rt_uint32_t	number_mask;

B
bernard.xiong 已提交
373
#if defined(RT_USING_EVENT)
374 375 376 377 378
	/* thread event */
	rt_uint32_t event_set;
	rt_uint8_t	event_info;
#endif

B
bernard.xiong@gmail.com 已提交
379 380
	rt_ubase_t	init_tick;								/**< thread's initialized tick 				*/
	rt_ubase_t 	remaining_tick;							/**< remaining tick 						*/
381

B
bernard.xiong@gmail.com 已提交
382
	struct rt_timer thread_timer;						/**< thread timer 							*/
383

B
bernard.xiong@gmail.com 已提交
384
	void 		(*cleanup)(struct rt_thread* tid);		/**< cleanup function when thread exit 		*/
385

B
bernard.xiong@gmail.com 已提交
386
	rt_uint32_t user_data;								/**< user data 								*/
387 388 389 390 391 392 393
};
/*@}*/

/**
 * @addtogroup IPC
 */
/*@{*/
B
bernard.xiong@gmail.com 已提交
394 395 396

/**
 * IPC flags and control command defitions
397
 */
B
bernard.xiong@gmail.com 已提交
398 399
#define RT_IPC_FLAG_FIFO				0x00			/**< FIFOed IPC. @ref IPC. 					*/
#define RT_IPC_FLAG_PRIO				0x01			/**< PRIOed IPC. @ref IPC. 					*/
400

B
bernard.xiong@gmail.com 已提交
401 402
#define RT_IPC_CMD_UNKNOWN				0x00			/**< unknown IPC command 					*/
#define RT_IPC_CMD_RESET				0x01			/**< reset IPC object 						*/
403

B
bernard.xiong@gmail.com 已提交
404 405
#define RT_WAITING_FOREVER				-1				/**< Block forever until get resource.		*/
#define RT_WAITING_NO					0				/**< Non-block. 							*/
406

B
bernard.xiong@gmail.com 已提交
407
/**
408 409 410 411
 * Base structure of IPC object
 */
struct rt_ipc_object
{
B
bernard.xiong@gmail.com 已提交
412
	struct rt_object parent;							/**< inherit from rt_object 				*/
413

B
bernard.xiong@gmail.com 已提交
414
	rt_list_t suspend_thread;							/**< threads pended on this resource 		*/
415 416 417
};

#ifdef RT_USING_SEMAPHORE
B
bernard.xiong@gmail.com 已提交
418 419
/**
 * Semaphore structure
420 421 422
 */
struct rt_semaphore
{
B
bernard.xiong@gmail.com 已提交
423
	struct rt_ipc_object parent;						/**< inherit from ipc_object 				*/
424

B
bernard.xiong@gmail.com 已提交
425
	rt_uint16_t value;									/**< value of semaphore. 					*/
426 427 428 429 430
};
typedef struct rt_semaphore* rt_sem_t;
#endif

#ifdef RT_USING_MUTEX
B
bernard.xiong@gmail.com 已提交
431 432
/**
 * Mutual exclusion (mutex) structure
433 434 435
 */
struct rt_mutex
{
B
bernard.xiong@gmail.com 已提交
436
	struct rt_ipc_object 	parent;						/**< inherit from ipc_object				*/
437

B
bernard.xiong@gmail.com 已提交
438
	rt_uint16_t 			value;						/**< value of mutex 						*/
439

B
bernard.xiong@gmail.com 已提交
440 441
	rt_uint8_t 				original_priority;			/**< priority of last thread hold the mutex */
	rt_uint8_t 				hold;			 			/**< numbers of thread hold the mutex 		*/
442

B
bernard.xiong@gmail.com 已提交
443
	struct rt_thread		*owner;						/**< current owner of mutex 				*/
444 445 446 447 448
};
typedef struct rt_mutex* rt_mutex_t;
#endif

#ifdef RT_USING_EVENT
B
bernard.xiong@gmail.com 已提交
449 450 451 452 453 454 455
/**
 * 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								*/

456
/*
B
bernard.xiong@gmail.com 已提交
457
 * event structure
458 459 460
 */
struct rt_event
{
B
bernard.xiong@gmail.com 已提交
461
	struct rt_ipc_object parent;						/**< inherit from ipc_object 				*/
462

B
bernard.xiong@gmail.com 已提交
463
	rt_uint32_t set;									/**< event set 								*/
464 465 466 467 468
};
typedef struct rt_event* rt_event_t;
#endif

#ifdef RT_USING_MAILBOX
B
bernard.xiong@gmail.com 已提交
469 470
/**
 * mailbox structure
471 472 473 474
 *
 */
struct rt_mailbox
{
B
bernard.xiong@gmail.com 已提交
475
	struct rt_ipc_object parent;						/**< inherit from ipc_object 				*/
476

B
bernard.xiong@gmail.com 已提交
477
	rt_uint32_t* msg_pool;								/**< start address of message buffer. 			*/
478

B
bernard.xiong@gmail.com 已提交
479
	rt_uint16_t size;									/**< size of message pool. 						*/
480

B
bernard.xiong@gmail.com 已提交
481 482
	rt_uint16_t entry;									/**< index of messages in msg_pool. 				*/
	rt_uint16_t in_offset, out_offset;					/**< in/output offset of the message buffer.		*/
483 484 485 486 487
};
typedef struct rt_mailbox* rt_mailbox_t;
#endif

#ifdef RT_USING_MESSAGEQUEUE
B
bernard.xiong@gmail.com 已提交
488 489
/**
 * message queue structure
490 491 492
 */
struct rt_messagequeue
{
B
bernard.xiong@gmail.com 已提交
493
	struct rt_ipc_object parent;						/**< inherit from ipc_object 				*/
494

B
bernard.xiong@gmail.com 已提交
495
	void* msg_pool;										/**< start address of message queue. 			*/
496

B
bernard.xiong@gmail.com 已提交
497 498
	rt_uint16_t msg_size;								/**< message size of each message. 				*/
	rt_uint16_t max_msgs;								/**< max number of messages. 					*/
499

B
bernard.xiong@gmail.com 已提交
500
	rt_uint16_t entry;									/**< index of messages in the queue. 			*/
501

B
bernard.xiong@gmail.com 已提交
502 503 504
	void* msg_queue_head;								/**< list head. 								*/
	void* msg_queue_tail;								/**< list tail. 								*/
	void* msg_queue_free;								/**< pointer indicated the free node of queue. 	*/
505 506 507 508 509 510 511 512 513 514 515 516 517 518
};
typedef struct rt_messagequeue* rt_mq_t;
#endif
/*@}*/

/**
 * @addtogroup MM
 */
/*@{*/
/*
 * memory management
 * heap & partition
 */
#ifdef RT_USING_MEMPOOL
B
bernard.xiong@gmail.com 已提交
519
/**
520 521 522 523
 * Base structure of Memory pool object
 */
struct rt_mempool
{
B
bernard.xiong@gmail.com 已提交
524
	struct rt_object parent;						/**< inherit from rt_object 					*/
525

B
bernard.xiong@gmail.com 已提交
526 527
	void		*start_address;						/**< memory pool start 							*/
	rt_size_t 	size;								/**< size of memory pool 						*/
528

B
bernard.xiong@gmail.com 已提交
529 530
	rt_size_t 	block_size;							/**< size of memory blocks 						*/
	rt_uint8_t	*block_list;						/**< memory blocks list 						*/
531

B
bernard.xiong@gmail.com 已提交
532 533
	rt_size_t 	block_total_count;					/**< numbers of memory block 					*/
	rt_size_t 	block_free_count;					/**< numbers of free memory block 				*/
534

B
bernard.xiong@gmail.com 已提交
535 536
	rt_list_t 	suspend_thread;						/**< threads pended on this resource 			*/
	rt_size_t 	suspend_thread_count;				/**< numbers of thread pended on this resource 	*/
537 538 539 540 541 542 543 544 545 546 547
};
typedef struct rt_mempool* rt_mp_t;
#endif
/*@}*/

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

B
bernard.xiong@gmail.com 已提交
548 549
/**
 * device (I/O) class type
550 551 552
 */
enum rt_device_class_type
{
B
bernard.xiong@gmail.com 已提交
553 554 555 556 557 558 559 560
	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_Unknown							/**< unknown device 							*/
561 562
};

B
bernard.xiong@gmail.com 已提交
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
/**
 * 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 							*/

/**
 * general device commands
 */
#define RT_DEVICE_CTRL_RESUME	   		0x01		/**< resume device 								*/
#define RT_DEVICE_CTRL_SUSPEND	    	0x02		/**< suspend device 							*/

/**
 * special device commands
 */
#define RT_DEVICE_CTRL_CHAR_STREAM		0x10		/**< stream mode on char device 				*/
#define RT_DEVICE_CTRL_BLK_GETGEOME		0x10		/**< get geometry information 					*/
#define RT_DEVICE_CTRL_NETIF_GETMAC		0x10		/**< get mac address 							*/
#define RT_DEVICE_CTRL_MTD_FORMAT		0x10		/**< format a MTD device 						*/
#define RT_DEVICE_CTRL_RTC_GET_TIME		0x10		/**< get time 									*/
#define RT_DEVICE_CTRL_RTC_SET_TIME		0x11		/**< set time 									*/
604

605
typedef struct rt_device* rt_device_t;
B
bernard.xiong@gmail.com 已提交
606 607
/**
 * Device structure
608 609 610
 */
struct rt_device
{
B
bernard.xiong@gmail.com 已提交
611
	struct rt_object parent;						/**< inherit from rt_object 					*/
612

B
bernard.xiong@gmail.com 已提交
613 614
	enum rt_device_class_type type;					/**< device type 								*/
	rt_uint16_t flag, open_flag;					/**< device flag and device open flag			*/
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632

	/* 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);

	/* 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, rt_uint8_t cmd, void *args);

#ifdef RT_USING_DEVICE_SUSPEND
	rt_err_t (*suspend) (rt_device_t dev);
	rt_err_t (*resumed) (rt_device_t dev);
#endif

B
bernard.xiong@gmail.com 已提交
633
	void* user_data;								/**< device private data 						*/
634 635
};

B
bernard.xiong@gmail.com 已提交
636 637 638
/**
 * block device geometry structure
 */
639 640
struct rt_device_blk_geometry
{
B
bernard.xiong@gmail.com 已提交
641 642 643
	rt_uint32_t sector_count;						/**< count of sectors							*/
	rt_uint32_t bytes_per_sector;					/**< number of bytes per sector 				*/
	rt_uint32_t block_size;							/**< size to erase one block 					*/
644
};
B
bernard.xiong@gmail.com 已提交
645
/*@}*/
646

B
bernard.xiong@gmail.com 已提交
647 648 649 650
/**
 * @addtogroup Module
 */
/*@{*/
qiuyiuestc's avatar
qiuyiuestc 已提交
651 652 653 654 655 656
#ifdef RT_USING_MODULE
/*
 * module system
 */

#define RT_MODULE_FLAG_WITHENTRY		0x00		/* with entry point								*/
B
bernard.xiong@gmail.com 已提交
657
#define RT_MODULE_FLAG_WITHOUTENTRY		0x01		/* without entry point							*/
qiuyiuestc's avatar
qiuyiuestc 已提交
658

B
bernard.xiong@gmail.com 已提交
659 660 661
/**
 * Application Module structure
 */
qiuyiuestc's avatar
qiuyiuestc 已提交
662 663
struct rt_module
{
B
bernard.xiong@gmail.com 已提交
664
	struct	rt_object parent;						/**< inherit from object */
qiuyiuestc's avatar
qiuyiuestc 已提交
665

B
bernard.xiong@gmail.com 已提交
666
	rt_uint8_t* module_space;						/**< module memory space						*/
qiuyiuestc's avatar
qiuyiuestc 已提交
667

B
bernard.xiong@gmail.com 已提交
668 669 670
	void*		module_entry;						/**< entry address of module's thread			*/
	rt_thread_t module_thread;						/**< stack size of module's thread				*/
	rt_uint32_t stack_size;							/**< priority of module's thread				*/
qiuyiuestc's avatar
qiuyiuestc 已提交
671 672 673
	rt_uint32_t thread_priority;

	/* module memory allocator */
B
bernard.xiong@gmail.com 已提交
674 675 676
	void*		mem_list;							/**< module's free memory list					*/
	rt_list_t	page_list;							/**< module's using page list	 				*/
	rt_mp_t	mpool;									/**< module's memory pool 						*/
qiuyiuestc's avatar
qiuyiuestc 已提交
677

B
bernard.xiong@gmail.com 已提交
678 679
	rt_uint32_t nsym;								/**< number of symbol in the module 			*/
	struct rt_module_symtab *symtab;				/**< module symbol table 						*/
qiuyiuestc's avatar
qiuyiuestc 已提交
680

B
bernard.xiong@gmail.com 已提交
681
	rt_uint32_t nref;								/**< reference count 							*/
qiuyiuestc's avatar
qiuyiuestc 已提交
682
	
B
bernard.xiong@gmail.com 已提交
683
	/**< object in this module, module object is the last basic object type */
qiuyiuestc's avatar
qiuyiuestc 已提交
684 685 686 687 688
	struct rt_object_information module_object[RT_Object_Class_Unknown];
};
typedef struct rt_module* rt_module_t;
#endif

689 690 691 692 693 694 695 696
/*@}*/
#endif

#ifdef __cplusplus
}
#endif

#endif