logo资料库

802.15.4 MAC应用程序编程接口(中).pdf

第1页 / 共57页
第2页 / 共57页
第3页 / 共57页
第4页 / 共57页
第5页 / 共57页
第6页 / 共57页
第7页 / 共57页
第8页 / 共57页
资料共57页,剩余部分请下载后查看
1、简介
1.1 目的
1.2 参考书目
1.3缩略语和定义
2、API概述
2.1 接口机制
2.1.1 信息传递函数调用
2.1.2 直接执行函数调用
2.1.3 回调函数
2.2 零拷贝数据接口
2.3 公共的常量和结构体
2.3.1 地址类型
2.3.2 状态
2.3.2.1 标准的状态值
2.3.2.2 专有的状态值
2.3.3 MAC安全级别
2.3.4 密钥标识符模式
2.3.5 安全类型
2.3.6 MAC定时值
3、初始化接口
3.1 简介
3.2 MAC_Init()
3.2.1 描述
3.2.2 原型
3.2.3 详细参数
3.2.4 返回值
3.3 MAC_InitDevice()
3.3.1 描述
3.3.2 原型
3.3.3 详细参数
3.3.4 返回值
3.4 MAC_InitCoord()
3.4.1 描述
3.4.2 原型
3.4.3 详细参数
3.4.4 返回值
3.5 MAC_InitSecurity()
3.5.1 描述
3.5.2 原型
3.5.3 详细参数
3.5.4 返回值
3.6 MAC_InitBeaconCoord()
3.6.1 描述
3.6.2 原型
3.6.3 详细参数
3.6.4 返回值
3.7 MAC_InitBeaconDevice()
3.7.1 描述
3.7.2 原型
3.7.3 详细参数
3.7.4 返回值
3.8 配置实例
4、数据接口
4.1 简介
4.2 公共的常量和结构体
4.2.1 数据头类型
4.2.2 数据常量
4.3 函数调用
4.3.1 MAC_McpsDataReq()
4.3.1.1 描述
4.3.1.2 原型
4.3.1.3 详细参数
4.3.1.4 返回值
4.3.2 MAC_McpsPurgeReq()
4.3.2.1 描述
4.3.2.2 原型
4.3.2.3 详细参数
4.3.2.4 返回值
4.3.3 MAC_McpsDataAlloc()
4.3.3.1 描述
4.3.3.2 原型
4.3.3.3 详细参数
4.3.3.4 返回值
4.4 回调函数事件
4.4.1 MAC_MCPS_DATA_IND
4.4.1.1 描述
4.4.1.2 详细参数
4.4.2 MAC_MCPS_DATA_CNF
4.4.2.1 描述
4.4.2.2 详细参数
4.4.3 MAC_MCPS_PURGE_CNF
4.4.3.1 描述
4.4.3.2 详细参数
5、管理接口
5.1 简介
5.2 公共的常量和结构
5.2.1 信道掩码
5.2.2 信道
5.2.3 信道页
5.2.4 能力信息
5.2.5 获取和设置属性
5.2.5.1 标准属性
5.2.5.2 专有属性
5.2.6 断开连接原因
5.2.7 扫描类型
5.2.8 特殊地址值
5.2.9 超帧格式
5.2.10 PAN描述符
5.2.11 未处理地址格式
5.3 函数调用
5.3.1 MAC_MlmeAssociateReq()
5.3.1.1 描述
5.3.1.2 原型
5.3.1.3 详细参数
5.3.1.4 返回值
5.3.2 MAC_MlmeAssociateRsp()
5.3.2.1 描述
5.3.2.2 原型
5.3.2.3 详细参数
5.3.2.4 返回值
5.3.3 MAC_MlmeDisassociateReq()
5.3.3.1 描述
5.3.3.2 原型
5.3.3.3 详细参数
5.3.3.4 返回值
5.3.4 MAC_MlmeGetReq()
5.3.4.1 描述
5.3.4.2 原型
5.3.4.3 详细参数
5.3.4.4 返回值
5.3.5 MAC_MlmeOrphanRsp()
5.3.5.1 描述
5.3.5.2 原型
5.3.5.3 详细参数
5.3.5.4 返回值
5.3.6 MAC_MlmePollReq()
5.3.6.1 描述
5.3.6.2 原型
5.3.6.3 详细参数
5.3.6.4 返回值
5.3.7 MAC_MlmeResetReq()
5.3.7.1 描述
5.3.7.2 原型
5.3.7.3 详细参数
5.3.7.4 返回值
5.3.8 MAC_MlmeScanReq()
5.3.8.1 描述
5.3.8.2 原型
5.3.8.3 详细参数
5.3.8.4 返回值
5.3.9 MAC_MlmeSetReq()
5.3.9.1 描述
5.3.9.2 原型
5.3.9.3 详细参数
5.3.9.4 返回值
5.3.10 MAC_MlmeStartReq()
5.3.10.1 描述
5.3.10.2 原型
5.3.10.3 详细参数
5.3.10.4 返回值
5.3.11 MAC_MlmeSyncReq()
5.3.11.1 描述
5.3.11.2 原型
5.3.11.3 详细参数
5.3.11.4 返回值
5.4 回调函数事件
5.4.1 MAC_MLME_ASSOCIATE_IND
5.4.1.1 描述
5.4.1.2 详细参数
5.4.2 MAC_MLME_ASSOCIATE_CNF
5.4.2.1 描述
5.4.2.2 详细参数
5.4.3 MAC_MLME_DISASSOCIATE_IND
5.4.3.1 描述
5.4.3.2 详细参数
5.4.4 MAC_MLME_DISASSOCIATE_CNF
5.4.4.1 描述
5.4.4.2 详细参数
5.4.5 MAC_MLME_BEACON_NOTIFY_IND
5.4.5.1 描述
5.4.5.2 详细参数
5.4.6 MAC_MLME_ORPHAN_IND
5.4.6.1 描述
5.4.6.2 详细参数
5.4.7 MAC_MLME_SCAN_CNF
5.4.7.1 描述
5.4.7.2 详细参数
5.4.8 MAC_MLME_START_CNF
5.4.8.1 描述
5.4.8.2 详细参数
5.4.9 MAC_MLME_SYNC_LOSS_IND
5.4.9.1 描述
5.4.9.2 详细参数
5.4.10 MAC_MLME_POLL_CNF
5.4.10.1 描述
5.4.10.2 详细参数
5.4.11 MAC_MLME_COMM_STATUS_IND
5.4.11.1 描述
5.4.11.2 详细参数
5.4.12 MAC_MLME_POLL_IND
5.4.12.1 描述
5.4.12.2 详细参数
6、扩展接口
6.1 简介
6.2 公共的常量和结构体
6.2.1 电源模式
6.3 函数调用
6.3.1 MAC_PwrOffReq()
6.3.1.1 描述
6.3.1.2 原型
6.3.1.3 详细参数
6.3.1.4 返回值
6.3.2 MAC_PwrOnReq()
6.3.2.1 描述
6.3.2.2 原型
6.3.2.3 详细参数
6.3.2.4 返回值
6.3.3 MAC_PwrMode()
6.3.3.1 描述
6.3.3.2 原型
6.3.3.3 详细参数
6.3.3.4 返回值
6.3.4 MAC_PwrNextTimeout()
6.3.4.1 描述
6.3.4.2 原型
6.3.4.3 详细参数
6.3.4.4 返回值
6.3.5 MAC_RandomByte()
6.3.5.1 描述
6.3.5.2 原型
6.3.5.3 详细参数
6.3.5.4 返回值
6.4 回调函数事件
6.4.1 MAC_PWR_ON_CNF
6.4.1.1 描述
7、回调接口
7.1.1 MAC_CbackEvent()
7.1.1.1 描述
7.1.1.2 原型
7.1.1.3 详细参数
7.1.1.4 返回值
7.1.2 MAC_CbackCheckPending()
7.1.2.1 描述
7.1.2.2 原型
7.1.2.3 详细参数
7.1.2.4 返回值
8、配置
8.1 配置常量
8.2 编译时间配置
9、方案
9.1 非信标网络的启动
9.2 非信标网络的扫描和连接
9.3 带信标网络的的扫描和同步
9.4 孤程序
9.5 直接数据事务
9.6 间接数据事务,数据轮询和清除
www.zigbee-sh.cn 郑州新双恒译 802.15.4 802.15.4 MACMACMACMAC 802.15.4 802.15.4 应用程序编程接口 版本:1.1 文件编号:F8W-2005-1503 2007 年 3 月 19 日 德州仪器 圣迭戈,CA USA +1 (619) 542-1200 版权 © 德州仪器 2006-2007 版权所有 违者必究
www.zigbee-sh.cn 郑州新双恒译 802.15.4MACAPI F8W-2005-1503 版本1.1 目录 1111、简介............................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................1111 1.1 目的....................................................................................................................................1 1.2 参考书目............................................................................................................................1 1.3 缩略语和定义....................................................................................................................1 2222、APIAPIAPIAPI概述............................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................2222 2.1 接口机制............................................................................................................................2 2.1.1 信息传递函数调用.................................................................................................2 2.1.2 直接执行函数调用.................................................................................................2 2.1.3 回调函数.................................................................................................................2 2.2 零拷贝数据接口................................................................................................................2 2.3 公共的常量和结构体........................................................................................................2 2.3.1 地址类型.................................................................................................................2 2.3.2 状态.........................................................................................................................3 2.3.2.1 标准的状态值..............................................................................................3 2.3.2.2 专有的状态值..............................................................................................4 2.3.3 MAC安全级别.......................................................................................................4 2.3.4 密钥标识符模式.....................................................................................................5 2.3.5 安全类型.................................................................................................................5 2.3.6 MAC校时值...........................................................................................................5 3333、初始化接口............................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................6666 3.1 简介....................................................................................................................................6 3.2 MAC_Init()........................................................................................................................ 6 3.2.1 描述.........................................................................................................................6 3.2.2 原型.........................................................................................................................6 3.2.3 详细参数.................................................................................................................6 3.2.4 返回值.....................................................................................................................6 3.3 MAC_InitDevice().............................................................................................................6 3.3.1 描述.........................................................................................................................6 3.3.2 原型.........................................................................................................................6 3.3.3 详细参数.................................................................................................................6 3.3.4 返回值.....................................................................................................................6 3.4 MAC_InitCoord().............................................................................................................. 7 3.4.1 描述.........................................................................................................................7 3.4.2 原型.........................................................................................................................7 3.4.3 详细参数.................................................................................................................7 3.4.4 返回值.....................................................................................................................7 3.5 MAC_InitSecurity()...........................................................................................................7 3.5.1 描述.........................................................................................................................7 3.5.2 原型.........................................................................................................................7 3.5.3 详细参数.................................................................................................................7 3.5.4 返回值.....................................................................................................................7 3.6 MAC_InitBeaconCoord().................................................................................................. 7 3.6.1 描述.........................................................................................................................7 3.6.2 原型.........................................................................................................................7 i 版权 © 德州仪器 2006-2007 版权所有 违者必究
www.zigbee-sh.cn 郑州新双恒译 802.15.4MACAPI F8W-2005-1503 版本1.1 3.6.3 详细参数.................................................................................................................7 3.6.4 返回值.....................................................................................................................8 3.7 MAC_InitBeaconDevice().................................................................................................8 3.7.1 描述.........................................................................................................................8 3.7.2 原型.........................................................................................................................8 3.7.3 详细参数.................................................................................................................8 3.7.4 返回值.....................................................................................................................8 3.8 配置实例............................................................................................................................8 4444、数据接口............................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................9999 4.1 简介....................................................................................................................................9 4.2 公共的常量和结构体........................................................................................................9 4.2.1 数据头类型.............................................................................................................9 4.2.2 数据常量.................................................................................................................9 4.3 函数调用............................................................................................................................9 4.3.1 MAC_McpsDataReq().............................................................................................9 4.3.1.1 描述..............................................................................................................9 4.3.1.2 原型............................................................................................................10 4.3.1.3 详细参数....................................................................................................10 4.3.1.4 返回值........................................................................................................11 4.3.2 MAC_McpsPurgeReq().........................................................................................12 4.3.2.1 描述............................................................................................................12 4.3.2.2 原型............................................................................................................12 4.3.2.3 详细参数....................................................................................................12 4.3.2.4 返回值........................................................................................................12 4.3.3 MAC_McpsDataAlloc()........................................................................................12 4.3.3.1 描述............................................................................................................12 4.3.3.2 原型............................................................................................................12 4.3.3.3 详细参数....................................................................................................12 4.3.3.4 返回值........................................................................................................12 4.4 回调函数事件..................................................................................................................13 4.4.1 MAC_MCPS_DATA_IND.....................................................................................13 4.4.1.1 描述............................................................................................................13 4.4.1.2 详细参数....................................................................................................13 4.4.2 MAC_MCPS_DATA_CNF....................................................................................14 4.4.2.1 描述............................................................................................................14 4.4.2.2 详细参数....................................................................................................14 4.4.3 MAC_MCPS_PURGE_CNF.................................................................................15 4.4.3.1 描述............................................................................................................15 4.4.3.2 详细参数....................................................................................................15 5555、管理接口....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................16161616 5.1 简介..................................................................................................................................16 5.2 公共的常量和结构..........................................................................................................16 5.2.1 信道掩码...............................................................................................................16 5.2.2 信道.......................................................................................................................16 5.2.3 信道页面...............................................................................................................16 5.2.4 能力信息...............................................................................................................17 ii 版权 © 德州仪器 2006-2007 版权所有 违者必究
www.zigbee-sh.cn 郑州新双恒译 802.15.4MACAPI F8W-2005-1503 版本1.1 5.2.5 获取和设置属性...................................................................................................17 5.2.5.1 标准属性....................................................................................................17 5.2.5.2 专有属性....................................................................................................19 5.2.6 断开连接原因.......................................................................................................19 5.2.7 扫描类型...............................................................................................................19 5.2.8 特殊地址值...........................................................................................................19 5.2.9 超帧格式...............................................................................................................20 5.2.10 PAN描述符.........................................................................................................20 5.2.11 未处理地址格式.................................................................................................21 5.3 函数调用..........................................................................................................................22 5.3.1 MAC_MlmeAssociateReq()...................................................................................22 5.3.1.1 描述............................................................................................................22 5.3.1.2 原型............................................................................................................22 5.3.1.3 详细参数....................................................................................................22 5.3.1.4 返回值........................................................................................................22 5.3.2 MAC_MlmeAssociateRsp()...................................................................................22 5.3.2.1 描述............................................................................................................22 5.3.2.2 原型............................................................................................................22 5.3.2.3 详细参数....................................................................................................22 5.3.2.4 返回值........................................................................................................23 5.3.3 MAC_MlmeDisassociateReq()..............................................................................23 5.3.3.1 描述............................................................................................................23 5.3.3.2 原型............................................................................................................23 5.3.3.3 详细参数....................................................................................................23 5.3.3.4 返回值........................................................................................................23 5.3.4 MAC_MlmeGetReq()............................................................................................24 5.3.4.1 描述............................................................................................................24 5.3.4.2 原型............................................................................................................24 5.3.4.3 详细参数....................................................................................................24 5.3.4.4 返回值........................................................................................................24 5.3.5 MAC_MlmeOrphanRsp()......................................................................................24 5.3.5.1 描述............................................................................................................24 5.3.5.2 原型............................................................................................................24 5.3.5.3 详细参数....................................................................................................24 5.3.5.4 返回值........................................................................................................24 5.3.6 MAC_MlmePollReq()...........................................................................................25 5.3.6.1 描述............................................................................................................25 5.3.6.2 原型............................................................................................................25 5.3.6.3 详细参数....................................................................................................25 5.3.6.4 返回值........................................................................................................25 5.3.7 MAC_MlmeResetReq().........................................................................................25 5.3.7.1 描述............................................................................................................25 5.3.7.2 原型............................................................................................................25 5.3.7.3 详细参数....................................................................................................25 5.3.7.4 返回值........................................................................................................25 5.3.8 MAC_MlmeScanReq()..........................................................................................26 iii 版权 © 德州仪器 2006-2007 版权所有 违者必究
www.zigbee-sh.cn 郑州新双恒译 802.15.4MACAPI F8W-2005-1503 版本1.1 5.3.8.1 描述............................................................................................................26 5.3.8.2 原型............................................................................................................26 5.3.8.3 详细参数....................................................................................................26 5.3.8.4 返回值........................................................................................................27 5.3.9 MAC_MlmeSetReq().............................................................................................27 5.3.9.1 描述............................................................................................................27 5.3.9.2 原型............................................................................................................27 5.3.9.3 详细参数....................................................................................................27 5.3.9.4 返回值........................................................................................................27 5.3.10 MAC_MlmeStartReq()........................................................................................28 5.3.10.1 描述..........................................................................................................28 5.3.10.2 原型..........................................................................................................28 5.3.10.3 详细参数..................................................................................................28 5.3.10.4 返回值......................................................................................................29 5.3.11 MAC_MlmeSyncReq().........................................................................................30 5.3.11.1 描述..........................................................................................................30 5.3.11.2 原型..........................................................................................................30 5.3.11.3 详细参数..................................................................................................30 5.3.11.4 返回值......................................................................................................30 5.4 回调函数事件..................................................................................................................31 5.4.1 MAC_MLME_ASSOCIATE_IND.........................................................................31 5.4.1.1 描述............................................................................................................31 5.4.1.2 详细参数....................................................................................................31 5.4.2 MAC_MLME_ASSOCIATE_CNF.........................................................................31 5.4.2.1 描述............................................................................................................31 5.4.2.2 详细参数....................................................................................................31 5.4.3 MAC_MLME_DISASSOCIATE_IND...................................................................32 5.4.3.1 描述............................................................................................................32 5.4.3.2 详细参数....................................................................................................32 5.4.4 MAC_MLME_DISASSOCIATE_CNF..................................................................32 5.4.4.1 描述............................................................................................................32 5.4.4.2 详细参数....................................................................................................32 5.4.5 MAC_MLME_BEACON_NOTIFY_IND..............................................................33 5.4.5.1 描述............................................................................................................33 5.4.5.2 详细参数....................................................................................................33 5.4.6 MAC_MLME_ORPHAN_IND..............................................................................33 5.4.6.1 描述............................................................................................................33 5.4.6.2 详细参数....................................................................................................33 5.4.7 MAC_MLME_SCAN_CNF...................................................................................34 5.4.7.1 描述............................................................................................................34 5.4.7.2 详细参数....................................................................................................34 5.4.8 MAC_MLME_START_CNF..................................................................................35 5.4.8.1 描述............................................................................................................35 5.4.8.2 详细参数....................................................................................................35 5.4.9 MAC_MLME_SYNC_LOSS_IND.........................................................................35 5.4.9.1 描述............................................................................................................35 iv 版权 © 德州仪器 2006-2007 版权所有 违者必究
www.zigbee-sh.cn 郑州新双恒译 802.15.4MACAPI F8W-2005-1503 版本1.1 5.4.9.2 详细参数....................................................................................................35 5.4.10 MAC_MLME_POLL_CNF.................................................................................36 5.4.10.1 描述..........................................................................................................36 5.4.10.2 详细参数..................................................................................................36 5.4.11 MAC_MLME_COMM_STATUS_IND................................................................36 5.4.11.1 描述..........................................................................................................36 5.4.11.2 详细参数..................................................................................................36 5.4.12 MAC_MLME_POLL_IND..................................................................................37 5.4.12.1 描述..........................................................................................................37 5.4.12.2 详细参数..................................................................................................37 6666、扩展接口....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................38383838 6.1 简介..................................................................................................................................38 6.2 公共的常量和结构体......................................................................................................38 6.2.1 电源模式...............................................................................................................38 6.3 函数调用..........................................................................................................................38 6.3.1 MAC_PwrOffReq()...............................................................................................38 6.3.1.1 描述............................................................................................................38 6.3.1.2 原型............................................................................................................38 6.3.1.3 详细参数....................................................................................................38 6.3.1.4 返回值........................................................................................................38 6.3.2 MAC_PwrOnReq()................................................................................................39 6.3.2.1 描述............................................................................................................39 6.3.2.2 原型............................................................................................................39 6.3.2.3 详细参数....................................................................................................39 6.3.2.4 返回值........................................................................................................39 6.3.3 MAC_PwrMode()..................................................................................................39 6.3.3.1 描述............................................................................................................39 6.3.3.2 原型............................................................................................................39 6.3.3.3 详细参数....................................................................................................39 6.3.3.4 返回值........................................................................................................39 6.3.4 MAC_PwrNextTimeout().....................................................................................39 6.3.4.1 描述............................................................................................................39 6.3.4.2 原型............................................................................................................39 6.3.4.3 详细参数....................................................................................................39 6.3.4.4 返回值........................................................................................................39 6.3.5 MAC_RandomByte()............................................................................................40 6.3.5.1 描述............................................................................................................40 6.3.5.2 原型............................................................................................................40 6.3.5.3 详细参数....................................................................................................40 6.3.5.4 返回值........................................................................................................40 6.4 回调函数事件..................................................................................................................40 6.4.1 MAC_PWR_ON_CNF...........................................................................................40 6.4.1.1 描述............................................................................................................40 7777、回调接口....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................41414141 7.1.1 MAC_CbackEvent()..............................................................................................41 7.1.1.1 描述............................................................................................................41 v 版权 © 德州仪器 2006-2007 版权所有 违者必究
www.zigbee-sh.cn 郑州新双恒译 802.15.4MACAPI F8W-2005-1503 版本1.1 7.1.1.2 原型............................................................................................................41 7.1.1.3 详细参数....................................................................................................41 7.1.1.4 返回值........................................................................................................42 7.1.2 MAC_CbackCheckPending()................................................................................42 7.1.2.1 描述............................................................................................................42 7.1.2.2 原型............................................................................................................42 7.1.2.3 详细参数....................................................................................................42 7.1.2.4 返回值........................................................................................................42 8888、配置....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................43434343 8.1 配置常量..........................................................................................................................43 8.2 编译时间配置..................................................................................................................43 9999、情景....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................44444444 9.1 非启用信标网络的启动..................................................................................................44 9.2 非启用信标网络的扫描和连接..................................................................................... 45 9.3 启用信标网络的的扫描和同步..................................................................................... 46 9.4 孤程序..............................................................................................................................47 9.5 直接数据事务..................................................................................................................48 9.6 间接数据事务,数据轮询和清除................................................................................. 49 vi 版权 © 德州仪器 2006-2007 版权所有 违者必究
www.zigbee-sh.cn 郑州新双恒译 802.15.4MACAPI F8W-2005-1503 版本1.1 1111、简介 1.1 目的 本文件描述了 802.15.4 MAC 软件的应用程序编程接口。API 提供了到 802.15.4 协议栈 管理和数据服务的接口。 1.2 参考书目 1. 2. IEEE Std 802.15.4-2006,15.4 章:低速率无线个人区域网(WPAN)的无线媒体访 问控制层(MAC)和物理层(PHY)规范,2006 年 9 月 8 日。 F8W-2003-0002,Z-StackOS 抽象层应用程序编程接口,版本 1.4,德州仪 器,2006 年 11 月 27 日。 1.3 缩略语和定义 AES API CAP CBC-MAC CCM Coordinator CSMA-CA CTR DSN FFD LQI MAC MCPS MIC MLME MSDU OSAL PAN PAN Coordinator PHY PIB RFD RSSI SFD 高级加密标准加密算法 应用程序编程接口 竞争访问期 密码块链接消息认证码 使用CTR的CBC-MAC的加密方法 一个全功能设备,可以接受连接请求,传输信标 载波监听多路访问/冲突。 计数器模式加密 数据序列号 全功能设备 链路质量指示 媒体访问控制 MAC公共子层(数据接口) 信息完整性代码 MAC子层管理实体(管理接口) MAC 服务数据单元 操作系统抽象层 个人区域网络 一个协调器,是一个PAN的主要协调器 物理层 PAN信息库 简化功能设备 接收信号强度指示 帧首界定符 1 版权 © 德州仪器 2006-2007 版权所有 违者必究
分享到:
收藏