Z-Stack OSAL 应用程序编程接口(API)
F8W-2003-0002 版本 1.5
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
www.zigbee-sh.cn))))译
www.zigbee-sh.cn
Z-Stack
Z-Stack
Z-Stack 操作系统抽象层
Z-Stack
操作系统抽象层
操作系统抽象层
操作系统抽象层
应用程序编程接口
应用程序编程接口
应用程序编程接口
应用程序编程接口
文件编号:F8W-2003-0002
德州仪器股份有限公司
美国加利福尼亚州圣迭戈
(619) 497-3845
版权©德州仪器股份有限公司公司 2005-2007 版权所有 违者必究
Z-Stack OSAL 应用程序编程接口(API)
F8W-2003-0002 版本 1.5
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
www.zigbee-sh.cn))))译
www.zigbee-sh.cn
版本
描述
1.0
1.1
1.2
1.3
1.4
1.5
最初发行的ZigBee1.0版本。
增加了个域网内存API说明中个域网初始化的注释。
修改了事物管理API 的讨论研究。
改变了标题页的标志, 改变了页脚的版权。
修改了电源管理的 API。
弃用了osal_self() 和 osalTaskAdd()。
日期
04/08/2005
07/22/2005
08/25/2005
02/27/2006
11/27/2006
12/18/2007
i
版权©德州仪器股份有限公司公司 2005-2007 版权所有 违者必究
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
www.zigbee-sh.cn))))译
www.zigbee-sh.cn
Z-Stack OSAL 应用程序编程接口(API)
F8W-2003-0002 版本 1.5
目录
1、引言............................................................................................................................................................. 6
1.1 目地.................................................................................................................................................. 6
1.2 范围.................................................................................................................................................. 6
1.3 简称.................................................................................................................................................. 6
2、API 概述......................................................................................................................................................7
2.1 概述.................................................................................................................................................. 7
3、信息管理 API..............................................................................................................................................8
3.1 介绍.................................................................................................................................................... 8
3.2 osal_msg_allocate ( )........................................................................................................................8
3.2.1 函数描述...............................................................................................................................8
3.2.2 函数原形...............................................................................................................................8
3.2.3 参数描述...............................................................................................................................8
3.2.4 返回值...................................................................................................................................8
3.3 osal_msg_deallocate( ).....................................................................................................................8
3.3.1 函数描述...............................................................................................................................8
3.3.2 函数原型...............................................................................................................................8
3.3.3 参数描述...............................................................................................................................8
3.3.4 返回值...................................................................................................................................8
3.4 osal_msg_send()...............................................................................................................................9
3.4.1 函数描述...............................................................................................................................9
3.4.2 函数原型...............................................................................................................................9
3.4.3 参数描述...............................................................................................................................9
3.4.4 返回值...................................................................................................................................9
3.5 osal_msg_receive()...........................................................................................................................10
3.5.1 函数描述.............................................................................................................................10
3.5.2 函数原型.............................................................................................................................10
3.5.3 参数描述.............................................................................................................................10
3.5.4 返回值.................................................................................................................................10
4、任务同步 API............................................................................................................................................11
4.1 介绍................................................................................................................................................ 11
4.2 osal_set_event()..............................................................................................................................11
4.2.1 函数描述.............................................................................................................................11
4.2.2 函数原型.............................................................................................................................11
4.2.3 参数描述.............................................................................................................................11
4.2.4 返回值.................................................................................................................................11
5、定时器管理 API........................................................................................................................................12
5.1 介绍................................................................................................................................................ 12
5.2 osal_start_timer()........................................................................................................................... 12
5.2.1 函数描述.............................................................................................................................12
5.2.2 函数原型.............................................................................................................................12
5.2.3 参数描述.............................................................................................................................12
5.2.4 返回值.................................................................................................................................12
5.3 osal_start_timerEx().......................................................................................................................13
5.3.1 函数描述.............................................................................................................................13
5.3.2 函数原型.............................................................................................................................13
5.3.3 参数描述.............................................................................................................................13
5.3.4 返回值.................................................................................................................................13
5.4 osal_stop_timer()............................................................................................................................13
版权©德州仪器股份有限公司公司 2005-2007 版权所有 违者必究
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
www.zigbee-sh.cn))))译
www.zigbee-sh.cn
Z-Stack OSAL 应用程序编程接口(API)
F8W-2003-0002 版本 1.5
5.4.1 函数描述.............................................................................................................................13
5.4.2 函数原型.............................................................................................................................13
5.4.3 参数描述.............................................................................................................................13
5.4.4 返回值.................................................................................................................................14
5.5 osal_stop_timerEx()....................................................................................................................... 14
5.5.1 函数描述.............................................................................................................................14
5.5.2 函数原型.............................................................................................................................14
5.5.3 参数描述.............................................................................................................................14
5.5.4 返回值.................................................................................................................................14
5.6 osal_GetSystemClock()..................................................................................................................14
5.6.1 函数描述.............................................................................................................................14
5.6.2 函数原型.............................................................................................................................14
5.6.3 参数描述.............................................................................................................................14
5.6.4 返回值.................................................................................................................................15
6、中断管理 API............................................................................................................................................16
6.1 介绍................................................................................................................................................ 16
6.2 osal_int_enable()............................................................................................................................ 16
6.2.1 函数描述.............................................................................................................................16
6.2.2 函数原型.............................................................................................................................16
6.2.3 参数描述.............................................................................................................................16
6.2.4 返回值.................................................................................................................................16
6.3 osal_int_disable()........................................................................................................................... 16
6.3.1 函数描述.............................................................................................................................16
6.3.2 函数原型.............................................................................................................................16
6.3.3 参数描述.............................................................................................................................16
6.3.4 返回值.................................................................................................................................17
7、任务管理 API............................................................................................................................................18
7.1 介绍................................................................................................................................................ 18
7.2 osal_init_system().......................................................................................................................... 18
7.2.1 函数描述.............................................................................................................................18
7.2.2 函数原型.............................................................................................................................18
7.2.3 参数描述.............................................................................................................................19
7.2.4 返回值.................................................................................................................................19
7.3 osal_start_system().........................................................................................................................19
7.3.1 函数描述.............................................................................................................................19
7.3.2 函数原型.............................................................................................................................19
7.3.3 参数描述.............................................................................................................................19
7.3.4 返回值.................................................................................................................................19
7.4 osal_self()....................................................................................................................................... 19
7.4.1 函数描述.............................................................................................................................19
7.5 osalTaskAdd ()............................................................................................................................... 19
7.5.1 函数描述.............................................................................................................................19
8、内存管理 API............................................................................................................................................20
8.1 介绍................................................................................................................................................ 20
8.2 osal_mem_alloc()...........................................................................................................................20
8.2.1 函数描述.............................................................................................................................20
8.2.2 函数原型.............................................................................................................................20
8.2.3 函数描述.............................................................................................................................20
8.2.4 返回值.................................................................................................................................20
8.3 osal_mem_free().............................................................................................................................20
版权©德州仪器股份有限公司公司 2005-2007 版权所有 违者必究
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
www.zigbee-sh.cn))))译
www.zigbee-sh.cn
Z-Stack OSAL 应用程序编程接口(API)
F8W-2003-0002 版本 1.5
8.3.1 函数描述.............................................................................................................................20
8.3.2 函数原型.............................................................................................................................20
8.3.3 参数描述.............................................................................................................................20
8.3.4 返回值.................................................................................................................................20
9、电源管理 API............................................................................................................................................21
9.1 介绍................................................................................................................................................ 21
9.2 osal_pwrmgr_device()....................................................................................................................21
9.2.1 函数描述.............................................................................................................................21
9.2.2 函数原型.............................................................................................................................21
9.2.3 参数描述.............................................................................................................................21
9.2.4 返回值.................................................................................................................................21
9.3 osal_pwrmgr_task_state().............................................................................................................. 21
9.3.1 函数描述.............................................................................................................................22
9.3.2 函数原型.............................................................................................................................22
9.3.3 参数描述.............................................................................................................................22
9.3.4 返回值.................................................................................................................................22
10、非易失性存储器的 API......................................................................................................................... 23
10.1 介绍.............................................................................................................................................. 23
10.2 osal_nv_item_init()...................................................................................................................... 23
10.2.1 函数描述...........................................................................................................................23
10.2.2 函数原型...........................................................................................................................24
10.2.3 参数描述...........................................................................................................................24
10.2.4 返回值...............................................................................................................................24
10.3 osal_nv_read()..............................................................................................................................24
10.3.1 函数描述...........................................................................................................................24
10.3.2 函数原型...........................................................................................................................24
10.3.3 参数描述...........................................................................................................................24
10.3.4 返回值...............................................................................................................................24
10.4 osal_nv_write().............................................................................................................................25
10.4.1 函数描述...........................................................................................................................25
10.4.2 函数原型...........................................................................................................................25
10.4.3 参数描述...........................................................................................................................25
10.4.4 返回值...............................................................................................................................25
10.5 osal_offsetof().............................................................................................................................. 25
10.5.1 函数描述...........................................................................................................................25
10.5.2 函数原型...........................................................................................................................25
10.5.3 参数描述...........................................................................................................................25
iv
版权©德州仪器股份有限公司公司 2005-2007 版权所有 违者必究
Z-Stack OSAL 应用程序编程接口(API)
F8W-2003-0002 版本 1.5
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
www.zigbee-sh.cn))))译
www.zigbee-sh.cn
1、引言
1.1 目地
文件的目地是规定操作系统抽象层的API。这个API允许Z-stack中的软件组件的要点或任务
环境(包括操纵系统或连接到中断系统)被写入独立于特定的操作系统中。该OSAL是被执行的目
标。
1.2 范围
文件中列举了通过OSAL提供所有调用函数。函数调用中细节给予充分的详述便于程序员
去实现它们。
1.3 简称
API
OSAL
PC
SPI
应用程序编程接口
操作系统抽象层
个人电脑
串行端口接口
1
版权©德州仪器股份有限公司公司 2005-2007 版权所有 违者必究
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
www.zigbee-sh.cn))))译
www.zigbee-sh.cn
Z-Stack OSAL 应用程序编程接口(API)
F8W-2003-0002 版本 1.5
2、API 概述
2.1 概述
操作系统抽象层通过特定的操作环境常用于屏蔽软件组成中的(Z-stack)。在一定程序上
它提供了与操作环境无关的下述功能。
1、任务记录,初始化,启动
2、任务之间的信息交换
3、任务同步
4、中断处理
5、定时器
6、内存分配
2
版权©德州仪器股份有限公司公司 2005-2007 版权所有 违者必究
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
www.zigbee-sh.cn))))译
www.zigbee-sh.cn
Z-Stack OSAL 应用程序编程接口(API)
F8W-2003-0002 版本 1.5
3、信息管理 API
3.1 介绍
信息管理 API 为任务和处理单元之间的信息交换提供了一种具有不同处理环境的机制
(例如,在一个控制循环中调用中断服务常规程序或函数)。这个 API 中的函数可以使任务
分配或回收信息缓冲区,给其它任务发送命令信息以及接收回复信息。
3.2
osal_msg_allocate ( )
3.2.1 函数描述
这个函数被一个任务调用去分配一个信息缓冲,这个任务/函数将填充这信息并且调用
osal_msg_send()发送信息到另一个任务中。假如缓冲器不能被分配,msg_ptr 将设置为空。
注明:不能把这个函数和 osal_mem_alloc()混淆,这个函数用来分配缓冲区以在任务之间发
送信息 [(使用)osal_msg_send()]任务中,运用 osal_mem_alloc()分配块存储。
3.2.2 函数原形
byte *osal_msg_allocate( uint16
len )
3.2.3 参数描述
len 是信息的长度。
3.2.4 返回值
这返回值是指向一个信息分配的缓冲区的指针。一个空值的返回标明了信息分配操作失败。
3.3
osal_msg_deallocate( )
3.3.1 函数描述
理机单元)调用。
这个函数用来回收一个信息缓冲区。在完成处理一个接收信息后这个函数被一个任务(或处
3.3.2 函数原型
byte osal_msg_deallocate( byte *msg_ptr
)
3.3.3 参数描述
msg_ptr 是指向必须被回收的信息缓冲的指针。
3.3.4 返回值
返回值指示了操作的结果。
3
版权©德州仪器股份有限公司公司 2005-2007 版权所有 违者必究