OSAL层提供了很多的API来对整个的协议栈进行管理。主要有下面的几类:信息管理、任务同步、时间管理、中断管理、任务管理、内存管理、电源管理以及非易失存储管理。看到这些管理是不是感觉越来越像一个操作系统了。 1. 信息管理API 信息管理为任务间的信息交换或者外部处理事件(例如:中断服务程序或一个控制循环内的函数调用)提供一种管理机制。包括允许任务分配或不分配信息缓存、发送命令信息到其他任务、接受应答信息等API函数。 (1)osal_msg_allocate ( ) 功能描述: 为信息分配缓存空间、任务调用或函数被调用的时候,该空间被信息填充或调用发送信息函数osal_msg_send()发送缓存空间的信息到其他任务。 原型: byte *osal_msg_allocate( uint16 len ) 参数: len :消息的长度 返回值: 指向消息缓冲区的指针,当分配失败时返回NULL 注意:不能与函数osal_mem_alloc()混淆,osal_mem_alloc()函数被用于为在任务间发送信息分配缓冲区,用该函数也可以分配一个存储区。 (2)osal_msg_deallocate( ) 功能描述: 用于收回缓冲区 原型:
byte osal_msg_deallocate( byte *msg_ptr ) 参数: Msg_ptr : 指向将要收回的缓冲区的指针 返回值: ZSUCCESS 回收成功 INVALID_MSG_POINTER 错误的指针 MSG_BUFFER_NOT_AVAIL 缓冲区在队列中 (3) osal_msg_send( ) 功能描述: 任务调用这个函数以实现发送指令或数据给另一个任务或处理单元。目标任务的标识必须是一个有效的系统任务,当调用osal_create_task ( )启动一个任务时,将会分配任务标识。 osal_msg_send()也将在目标任务的事件列表中设置SYS_EVENT_MSG 原型: byte osal_msg_send( byte destination_task, byte *msg_ptr ) 参数: destination_task :目标任务的标识 msg_ptr : 指向消息缓冲区的指针,必须是osal_msg_allocate ( )函数分配的有效的数据缓存 返回值: 返回一个字节,指示操作的结果. ZSUCCESS 消息发送成功 INVALID_MSG_POINTER 无效指针 INVALID_TASK 目标任务无效 (4)osal_msg_receive( ) 功能描述: 任务调用这个函数来接收消息。消息处理完毕后,发送消息的任务必须调用osal_msg_deallocate()收回缓冲区。一个任务接收一个命令信息是,调用该函数 原型: byte *osal_msg_receive( byte task_id ) 参数: task_id :消息发送者的任务标识 返回值: 指向消息所存放的缓冲区指针,如果没有收到消息将返回NULL。 2 同步任务API 这个API使能一个任务等待一个事件的发生和返回控制而不是一直等待。在这个API中的函数可以用来为任务设置事件,立刻通知任务有事件被设置。 osal_set_event( ) 功能描述: 函数用来设置一个任务的事件标志 原型: byte osal_set_event( byte task_id, UINT16 event_flag ) 参数: task_id :任务标识 event_flag :是2个字节的位图,每个位特指一个事件。只有一个系统事件(SYS_EVENT_MSG),其他事件在接收任务中定义。 返回值: ZSUCCESS 成功设置 INVALID_TASK 无效任务 3.. 时间管理API 这个API允许内部任务(Z-Stack)以及应用层任务使用定时器。函数提供了启动和停止定时器的功能,定时器最小增量为1MS。 (1) osal_start_timer( ) 功能描述: 启动一个定时器,当定时器终止时,指定的事件标志位被设置。通过在任务中调用osal_start_timer函数设置时间标志位。如果指明任务ID,则可以用osal_start_timerEx()函数替代osal_start_timer(). 原型: byte osal_start_timer(UINT16 event_id, UINT16 timeout_value); 参数: event_id : 用户定义的事件标志位event bit. 当定时器到点时,事件将通知任务。 timeout_value :定时值(ms) 返回值: ZSUCCESS Timer 成功开启 NO_TIMER_AVAILABLE 无法开启 (2) osal_start_timerEx( ) 功能描述: 功能与osal_start_timer()相近,只不过参数多了一个任务ID,这个函数允许调用者为另一个任务启动定时器 原型:
byte osal_start_timerEx( byte taskID, UINT16 event_id, UINT16 timeout_value); 参数: 参数1:taskID 当定时器终止时,得到该事件的任务ID 参数2:event_id,是用户定义的事件位,当定时器终止时,正在调用的任务将被通报 参数3:定时器事件被设置之前时间的计数 返回值: ZSUCCESS Timer 成功开启 NO_TIMER_AVAILABLE 无法开启 (3)osal_stop_timer( ) 功能描述: 停止正在运行的定时器,停止外部事件调用osal_stop_timerEx(),可以停止不同任务的定时器。 原型: byte osal_stop_timer( UINT16 event_id ); 参数: event_id :将要结束的目标事件(该事件是启动定时器的事件)定时器的标识符 返回值: ZSUCCESS Timer 成功停止 INVALID_EVENT_ID 无效事件 (4)osal_stop_timerEx( ) 功能描述: 结束外部事件的定时器,指明了任务的ID 原型: byte osal_stop_timerEx( byte task_id, UINT16 event_id ); 参数: 参数1:停止定时器所在的任务ID 参数2:被停止定时器的标识符 返回值 ZSUCCESS Timer 成功停止 INVALID_EVENT_ID 无效事件 (5)osal_GetSystemClock( ) 功能描述: 读取系统时间 原型: uint32 osal_GetSystemClock( void ); 参数: 无 返回值: 系统时间(ms) 4 中断管理API 这些API实现任务与外部中断的接口,函数允许一个任务关联每一个具体的中断程序程序,可以开关中断。在中断服务程序内,其他任务可以设置事件。 (1) osal_int_enable( ) 功能描述: 函数用于使能中断。一旦允许中断发生将引起中断分配的服务程序运行。 原型: byte osal_int_enable( byte interrupt_id ) 参数: interrupt_id :被允许的中断的标识符。 返回值: ZSUCCESS Interrupt 成功使能 INVALID_INTERRUPT_ID 无效中断 (2)osal_int_disable( ) 功能描述: 关闭中断 原型: byte osal_int_disable( byte interrupt_id ) 参数:
被禁止中断的标识符 返回值:
ZSUCCESS Interrupt 成功关闭 INVALID_INTERRUPT_ID 无效中断
|