logo资料库

《Z-Stack操作系统抽象层应用程序编程接口》(中).pdf

第1页 / 共26页
第2页 / 共26页
第3页 / 共26页
第4页 / 共26页
第5页 / 共26页
第6页 / 共26页
第7页 / 共26页
第8页 / 共26页
资料共26页,剩余部分请下载后查看
1、引言
1.1目地
1.2 范围
1.3 简称
2、API概述
2.1 概述
3、信息管理API
3.1 介绍
3.2 osal_msg_allocate()
3.2.1 函数描述
3.2.2 函数原形
3.2.3 参数描述
3.2.4 返回值
3.3 osal_msg_deallocate()
3.3.1 函数描述
3.3.2 函数原型
3.3.3 参数描述
3.3.4 返回值
3.4 osal_msg_send()
3.4.1 函数描述
3.4.2 函数原型
3.4.3 参数描述
3.4.4 返回值
3.5 osal_msg_receive()
3.5.1 函数描述
3.5.2 函数原型
3.5.3 参数描述
3.5.4 返回值
4、任务同步API
4.1 介绍
4.2 osal_set_event()
4.2.1 函数描述
4.2.2 函数原型
4.2.3 参数描述
4.2.4 返回值
5、定时器管理API
5.1 介绍
5.2 osal_start_timer()
5.2.1 函数描述
5.2.2 函数原型
5.2.3 参数描述
5.2.4 返回值
5.3 osal_start_timerEx()
5.3.1 函数描述
5.3.2 函数原型
5.3.3 参数描述
5.3.4 返回值
5.4 osal_stop_timer()
5.4.1 函数描述
5.4.2 函数原型
5.4.3 参数描述
5.4.4 返回值
5.5 osal_stop_timerEx()
5.5.1 函数描述
5.5.2 函数原型
5.5.3 参数描述
5.5.4 返回值
5.6 osal_GetSystemClock()
5.6.1 函数描述
5.6.2 函数原型
5.6.3 参数描述
5.6.4 返回值
6、中断管理API
6.1 介绍
6.2 osal_int_enable()
6.2.1 函数描述
6.2.2 函数原型
6.2.3 参数描述
6.2.4 返回值
6.3 osal_int_disable()
6.3.1 函数描述
6.3.2 函数原型
6.3.3 参数描述
6.3.4 返回值
7、任务管理API
7.1 介绍
7.2 osal_init_system()
7.2.1 函数描述
7.2.2 函数原型
7.2.3 参数描述
7.2.4 返回值
7.3 osal_start_system()
7.3.1 函数描述
7.3.2 函数原型
7.3.3 参数描述
7.3.4 返回值
7.4 osal_self()
7.4.1 函数描述
7.5 osalTaskAdd()
7.5.1 函数描述
8、内存管理API
8.1 介绍
8.2 osal_mem_alloc()
8.2.1 函数描述
8.2.2 函数原型
8.2.3 函数描述
8.2.4 返回值
8.3 osal_mem_free()
8.3.1 函数描述
8.3.2 函数原型
8.3.3 参数描述
8.3.4 返回值
9、电源管理API
9.1 介绍
9.2 osal_pwrmgr_device()
9.2.1 函数描述
9.2.2 函数原型
9.2.3 参数描述
9.2.4 返回值
9.3 osal_pwrmgr_task_state()
9.3.1 函数描述
9.3.2 函数原型
9.3.3 参数描述
9.3.4 返回值
10、非易失性存储器的API
10.1 介绍
10.2 osal_nv_item_init()
10.2.1 函数描述
10.2.2 函数原型
10.2.3 参数描述
10.2.4 返回值
10.3 osal_nv_read()
10.3.1 函数描述
10.3.2 函数原型
10.3.3 参数描述
10.3.4 返回值
10.4 osal_nv_write()
10.4.1 函数描述
10.4.2 函数原型
10.4.3 参数描述
10.4.4 返回值
10.5 osal_offsetof()
10.5.1 函数描述
10.5.2 函数原型
10.5.3 参数描述
www.zigbee-sh.cn 郑州新双恒译 Z-Stack Z-Stack Z-Stack Z-Stack 操作系统抽象层 应用程序编程接口 文件编号:F8W-2003-0002 德州仪器股份有限公司 美国加利福尼亚州圣迭戈 (619) 497-3845 版权 © 德州仪器股份有限公司 2005-2007 版权所有 违者必究
Z-StackOSAL 应用程序编程接口(API) F8W-2003-0002 版本1.5 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 ii 版权 © 德州仪器股份有限公司 2005-2007 版权所有 违者必究
Z-StackOSAL 应用程序编程接口(API) F8W-2003-0002 版本1.5 www.zigbee-sh.cn 郑州新双恒译 目录 1111、引言................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................1111 1.1 目地.................................................................................................................................................... 1 1.2 范围.................................................................................................................................................... 1 1.3 简称.................................................................................................................................................... 1 2222、APIAPIAPIAPI 概述............................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................ 2222 2.1 概述.................................................................................................................................................... 2 3333、信息管理 APIAPIAPIAPI................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................ 3333 3.1 介绍.................................................................................................................................................... 3 3.2 osal_msg_allocate ( )..........................................................................................................................3 3.2.1 函数描述.................................................................................................................................3 3.2.2 函数原形.................................................................................................................................3 3.2.3 参数描述.................................................................................................................................3 3.2.4 返回值.....................................................................................................................................3 3.3 osal_msg_deallocate( )....................................................................................................................... 3 3.3.1 函数描述.................................................................................................................................3 3.3.2 函数原型.................................................................................................................................3 3.3.3 参数描述.................................................................................................................................3 3.3.4 返回值.....................................................................................................................................3 3.4 osal_msg_send()................................................................................................................................. 4 3.4.1 函数描述.................................................................................................................................4 3.4.2 函数原型.................................................................................................................................4 3.4.3 参数描述.................................................................................................................................4 3.4.4 返回值.....................................................................................................................................4 3.5 osal_msg_receive().............................................................................................................................5 3.5.1 函数描述.................................................................................................................................5 3.5.2 函数原型.................................................................................................................................5 3.5.3 参数描述.................................................................................................................................5 3.5.4 返回值.....................................................................................................................................5 4444、任务同步 APIAPIAPIAPI................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................ 6666 4.1 介绍.................................................................................................................................................... 6 4.2 osal_set_event()..................................................................................................................................6 4.2.1 函数描述.................................................................................................................................6 4.2.2 函数原型.................................................................................................................................6 4.2.3 参数描述.................................................................................................................................6 4.2.4 返回值.....................................................................................................................................6 5555、定时器管理 APIAPIAPIAPI................................................................................................................................................................................................................................................................................................................................................................................................................................................................................7777 5.1 介绍.................................................................................................................................................... 7 5.2 osal_start_timer()................................................................................................................................7 5.2.1 函数描述.................................................................................................................................7 5.2.2 函数原型.................................................................................................................................7 5.2.3 参数描述.................................................................................................................................7 5.2.4 返回值.....................................................................................................................................7 5.3 osal_start_timerEx()........................................................................................................................... 8 5.3.1 函数描述.................................................................................................................................8 5.3.2 函数原型.................................................................................................................................8 5.3.3 参数描述.................................................................................................................................8 iii 版权 © 德州仪器股份有限公司 2005-2007 版权所有 违者必究
Z-StackOSAL 应用程序编程接口(API) F8W-2003-0002 版本1.5 www.zigbee-sh.cn 郑州新双恒译 5.3.4 返回值.....................................................................................................................................8 5.4 osal_stop_timer()................................................................................................................................8 5.4.1 函数描述.................................................................................................................................8 5.4.2 函数原型.................................................................................................................................8 5.4.3 参数描述.................................................................................................................................8 5.4.4 返回值.....................................................................................................................................9 5.5 osal_stop_timerEx()........................................................................................................................... 9 5.5.1 函数描述.................................................................................................................................9 5.5.2 函数原型.................................................................................................................................9 5.5.3 参数描述.................................................................................................................................9 5.5.4 返回值.....................................................................................................................................9 5.6 osal_GetSystemClock()......................................................................................................................9 5.6.1 函数描述.................................................................................................................................9 5.6.2 函数原型.................................................................................................................................9 5.6.3 参数描述.................................................................................................................................9 5.6.4 返回值...................................................................................................................................10 6666、中断管理 APIAPIAPIAPI........................................................................................................................................................................................................................................................................................................................................................................................................................................................................................ 10101010 6.1 介绍.................................................................................................................................................. 11 6.2 osal_int_enable().............................................................................................................................. 11 6.2.1 函数描述...............................................................................................................................11 6.2.2 函数原型...............................................................................................................................11 6.2.3 参数描述...............................................................................................................................11 6.2.4 返回值...................................................................................................................................11 6.3 osal_int_disable()..............................................................................................................................11 6.3.1 函数描述...............................................................................................................................11 6.3.2 函数原型...............................................................................................................................11 6.3.3 参数描述...............................................................................................................................11 6.3.4 返回值...................................................................................................................................11 7777、任务管理 APIAPIAPIAPI........................................................................................................................................................................................................................................................................................................................................................................................................................................................................................ 12121212 7.1 介绍.................................................................................................................................................. 13 7.2 osal_init_system().............................................................................................................................13 7.2.1 函数描述...............................................................................................................................13 7.2.2 函数原型...............................................................................................................................13 7.2.3 参数描述...............................................................................................................................13 7.2.4 返回值...................................................................................................................................14 7.3 osal_start_system()...........................................................................................................................14 7.3.1 函数描述...............................................................................................................................14 7.3.2 函数原型...............................................................................................................................14 7.3.3 参数描述...............................................................................................................................14 7.3.4 返回值...................................................................................................................................14 7.4 osal_self()......................................................................................................................................... 14 7.4.1 函数描述...............................................................................................................................14 7.5 osalTaskAdd ()................................................................................................................................. 14 7.5.1 函数描述...............................................................................................................................14 8888、内存管理 APIAPIAPIAPI........................................................................................................................................................................................................................................................................................................................................................................................................................................................................................ 14141414 8.1 介绍.................................................................................................................................................. 15 8.2 osal_mem_alloc()............................................................................................................................. 15 8.2.1 函数描述...............................................................................................................................15 iv 版权 © 德州仪器股份有限公司 2005-2007 版权所有 违者必究
Z-StackOSAL 应用程序编程接口(API) F8W-2003-0002 版本1.5 www.zigbee-sh.cn 郑州新双恒译 8.2.2 函数原型...............................................................................................................................15 8.2.3 函数描述...............................................................................................................................15 8.2.4 返回值...................................................................................................................................15 8.3 osal_mem_free()...............................................................................................................................15 8.3.1 函数描述...............................................................................................................................15 8.3.2 函数原型...............................................................................................................................15 8.3.3 参数描述...............................................................................................................................15 8.3.4 返回值...................................................................................................................................15 9999、电源管理 APIAPIAPIAPI........................................................................................................................................................................................................................................................................................................................................................................................................................................................................................ 15151515 9.1 介绍.................................................................................................................................................. 16 9.2 osal_pwrmgr_device()......................................................................................................................16 9.2.1 函数描述...............................................................................................................................16 9.2.2 函数原型...............................................................................................................................16 9.2.3 参数描述...............................................................................................................................16 9.2.4 返回值...................................................................................................................................16 9.3 osal_pwrmgr_task_state().................................................................................................................16 9.3.1 函数描述...............................................................................................................................17 9.3.2 函数原型...............................................................................................................................17 9.3.3 参数描述...............................................................................................................................17 9.3.4 返回值...................................................................................................................................17 10101010、非易失性存储器的 APIAPIAPIAPI................................................................................................................................................................................................................................................................................................................................................................................................................17171717 10.1 介绍................................................................................................................................................ 18 10.2 osal_nv_item_init().........................................................................................................................18 10.2.1 函数描述.............................................................................................................................18 10.2.2 函数原型.............................................................................................................................18 10.2.3 参数描述.............................................................................................................................19 10.2.4 返回值.................................................................................................................................19 10.3 osal_nv_read()................................................................................................................................ 19 10.3.1 函数描述.............................................................................................................................19 10.3.2 函数原型.............................................................................................................................19 10.3.3 参数描述.............................................................................................................................19 10.3.4 返回值.................................................................................................................................19 10.4 osal_nv_write()...............................................................................................................................19 10.4.1 函数描述.............................................................................................................................19 10.4.2 函数原型.............................................................................................................................20 10.4.3 参数描述.............................................................................................................................20 10.4.4 返回值.................................................................................................................................20 10.5 osal_offsetof().................................................................................................................................20 10.5.1 函数描述.............................................................................................................................20 10.5.2 函数原型.............................................................................................................................20 10.5.3 参数描述.............................................................................................................................20 v 版权 © 德州仪器股份有限公司 2005-2007 版权所有 违者必究
Z-StackOSAL 应用程序编程接口(API) F8W-2003-0002 版本1.5 www.zigbee-sh.cn 郑州新双恒译 1、引言 1.1 目地 文件的目地是规定操作系统抽象层的API。这个API允许Z-stack中的软件组件的要点或任务环境 (包括操纵系统或连接到中断系统)被写入独立于特定的操作系统中。该OSAL是被执行的目标。 1.2 范围 文件中列举了通过OSAL提供所有调用函数。函数调用中细节给予充分的详述便于程序员去实 现它们。 1.3 简称 API OSAL PC SPI 应用程序编程接口 操作系统抽象层 个人电脑 串行端口接口 1 版权 © 德州仪器股份有限公司 2005-2007 版权所有 违者必究
Z-StackOSAL 应用程序编程接口(API) F8W-2003-0002 版本1.5 www.zigbee-sh.cn 郑州新双恒译 2、API 概述 2.1 概述 操作系统抽象层通过特定的操作环境常用于屏蔽软件组成中的(Z-stack)。在一定程序上它提 供了与操作环境无关的下述功能。 1、任务记录,初始化,启动 2、任务之间的信息交换 3、任务同步 4、中断处理 5、定时器 6、内存分配 2 版权 © 德州仪器股份有限公司 2005-2007 版权所有 违者必究
Z-StackOSAL 应用程序编程接口(API) F8W-2003-0002 版本1.5 www.zigbee-sh.cn 郑州新双恒译 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 版权所有 违者必究
分享到:
收藏