HID_Class_AN1163_Final.book

Size: px

Start display at page:

Download "HID_Class_AN1163_Final.book"

蛟状杭
5 years ago
Views:

1 嵌入式设备上的 USB HID 类 AN1163 作者 : 引言人机接口设备 (Human Interface Device, HID) 是一类用在通用串行总线 (Universal Serial Bus,USB) 的设备构成 HID 类的设备是人们可以用来控制计算机系统操作的设备这样的设备包括但不只限于 : 鼠标键盘操纵杆按钮及开关人机接口设备除了提供来自人机接口的信息之外, 还提供各种类型的输出来表明计算机系统采取的操作本应用笔记讨论并提供一个 HID 设备功能驱动程序对于运行在具备 USB 外设的 Microchip 32 位 PIC 单片机产品上的应用, 几乎都可以集成这一驱动程序 HID 功能驱动程序使用 Microchip PIC32 USB 设备栈随本 HID 应用笔记一起提供的, 还有一个演示应用来展示 HID 设备功能驱动程序这个 HID 演示应用模拟鼠标假设 Sean Justice Microchip Technology Inc. 假定读者熟悉下列 Microchip 开发工具 :MPLAB IDE 和 MPLAB REAL ICE 在线仿真器还假设读者熟悉 C 程序设计语言以及 USB 设备协议和描述符本文档中使用了这些技术的术语, 但只简要概述了其概念建议资深读者阅读相关的规范功能与特性本应用笔记给出了 HID 设备类驱动程序的主要构成部分 Microchip HID 设备类驱动程序融合了下列功能特性 : 功能与 RTOS 或应用无关支持 Microchip MPLAB IDE 工具套件支持 HID 1.1 规范, HID 1.1 规范见 Universal Serial Bus (USB) Device Class Definition for Human Devices (HID), Version 1.11 ( 可通过因特网的以下 URL 获得 : 只使用一个 USB 端点给出了用来创建 HID 报告的宏处理多个 HID 报告处理标准的 HID USB 配置请求, 如 Universal Serial Bus Specification, Revision 2.0 第 9 章中所述 ( 限制由于所开发的 HID 是用在嵌入式系统中, 存在的限制是那些通过 USB 设备栈继承而来的限制 ( 请参阅 Microchip 应用笔记 AN1176 PIC32 USB 设备栈编程指南 ) 系统硬件本应用和固件的开发, 针对的是下列硬件 : PIC32 系列单片机 PIM (Processor Interface Module, 处理器接口模块 ), 支持 USB Microchip Explorer 16 开发板 USB PICtail Plus 子板可以修改 USB 设备和 HID 功能驱动程序源文件, 以便能够使用其他开发板, 适应大多数的硬件差异 2009 Microchip Technology Inc. DS01163A_CN 第 1 页

2 PIC MCU 存储器资源需求 HID 功能驱动程序继承了 USB 设备栈的全部存储器需求更多信息, 请参阅 AN1176 PIC32 USB 设备栈编程指南的存储器资源需求 HID 功能驱动程序占用的闪存和 RAM 存储器如下表所示 : 表 1: 存储器需求存储器闪存 RAM HID 功能驱动程序应用定义下列项 : USB 描述符表 HID 报告结构任何 HID 功能驱动程序应用都需要 USB 描述符表和 HID 报告结构 USB 描述符表的存储器需求如下表所示 : 表 2: USB 描述符表存储器闪存大小 3,284 字节 160 字节 HID 报告结构的存储器需求如下表所示 : 表 3: HID 报告结构存储器闪存大小 56 字节大小 1076 字节 USB 描述符表和 HID 报告所占用的存储器资源大小可能会有不同, 受各种因素 ( 包括但不局限于下列条件 ) 的影响 : 用户是否打算使用多个 USB 功能驱动程序 - 配置数接口数和端点配置数 HID 报告的大小和定义安装源文件 Microchip HID 功能驱动程序的完整源代码可以从 Microchip 网站下载 ( 附录 F: HID 功能驱动程序的源代码 ) 源代码以 Microsoft Windows 安装文件的形式提供执行下列步骤, 完成安装 : 1. 执行安装文件 Windows 安装向导将指导您完成安装过程 2. 在继续安装之前, 必须点击 I Accept( 我接受 ), 接受软件许可协议 3. 安装过程完成之后, 应该看到如下的目录结构 : a) \PIC32 Solutions\Microchip\USB 下的 hid_device_driver 目录此目录中含有 HID 功能驱动程序的源文件和文档 b) PIC32 Solutions\ Microchip\Include\USB 下的 usb_func_hid 目录此目录中含有 PIC32 USB 设备栈和 HID 功能驱动程序的包含文件 c) \PIC32 Solutions 之下的 usb_hid_mouse_device_demo 目录此目录中含有 HID 功能驱动程序鼠标演示的演示项目和源文件 4. 阅读版本说明, 了解最新版本特定的功能特性和限制 DS01163A_CN 第 2 页 2009 Microchip Technology Inc.

3 源文件构成 HID 设备类由多个文件组成, 文件分别在多个目录中表 4 给出了目录结构表 4: HID 源文件目录结构文件目录说明 hid.c \PIC32 Solutions\Microchip\USB\hid_device_driver USB HID 设备类驱动程序 hiddsc.tmpl \PIC32 Solutions\Microchip\USB\hid_device_driver HID 描述符模版 hidreport.tmpl \PIC32 Solutions\Microchip\USB\hid_device_driver HID 报告模版 usb_device_hid.h \PIC32 Solutions\Microchip\Include\USB API 定义和可修改的宏 hidpri.h \PIC32 Solutions\Microchip\USB\hid_device_driver 私有函数和宏定义 hiddesc.h \PIC32 Solutions\Microchip\Include\USB USB HID 描述符 hidreport.h \PIC32 Solutions\Microchip\Include\USB HID 报告定义演示应用随 Microchip HID 功能驱动程序一起提供的, 还有一个演示应用, 它通过模拟计算机鼠标演示 HID 功能驱动程序演示应用旨在运行在 Explorer 16 开发板上, 使用 Microchip USB 设备栈软件不过, 可以修改应用以支持任何开发板鼠标模拟演示应用提供下列服务 : USB 设备枚举为 HID 功能驱动程序当 Explorer 16 板上的开关 SW3 (RD6) 按下时, 仿真鼠标下列操作将使鼠标按指定方向移动 : - 按下开关 SW6 (RD7), 鼠标向右移动 - 按下开关 SW6 (RD7) 和 SW4 (RD13), 鼠标向左移动 - 按下开关 SW5 (RA7), 鼠标向上移动 - 按下开关 SW5 (RA7) 和 SW4 (RD13), 鼠标向下移动 2009 Microchip Technology Inc. DS01163A_CN 第 3 页

4 编程演示应用要把演示应用编程到目标器件中, 必须使用 MPLAB REAL ICE 在线仿真器下列步骤都假设您将使用 MPLAB IDE 如果不是的话, 请参考您所用编程器的说明书 1. 把 MPLAB REAL ICE 在线仿真器连接到 Explorer 16 板或您的目标板 2. 给目标板上电 3. 启动 MPLAB IDE 4. 选中您选择的支持 USB 的 PIC32 器件 ( 仅在导入先前已编译好的十六进制文件时才需要这一步 ) 5. 使能 MPLAB REAL ICE, 把它作为编程器 6. 如果打算使用先前已编译好的十六进制文件, 把文件导入 MPLAB 7. 如果要重新编译十六进制文件, 打开项目文件, 执行编译 (build) 过程, 创建应用程序的十六进制文件 8. 演示应用包含了 Explorer 16 板所需的必要配置选项如果要对其他类型的开发板编程, 请确保从 MPLAB IDE 配置设定菜单中选择恰当的振荡器模式 9. 从 MPLAB IDE 中选择 Programmer ( 编程器 ) 菜单项, 然后点击 Select Programmer->6 REAL ICE ( 选择编译器 ->6 REAL ICE) 10. MPLAB IDE 检测到 REAL ICE 在线仿真器和 PIC MCU 后, 选择 Programmer 菜单项, 点击 Program ( 编程 ) 对器件进行编程 11. 几秒钟之后, 应该看到消息 Programming successful ( 编程成功 ) 如果没有看到, 仔细检查开发板和 MPLAB REAL ICE 的连接进一步的帮助请参阅 MPLAB IDE 和 REAL ICE 联机帮助 12. 移去开发板的电源, 把 MPLAB REAL ICE 电缆从目标板上断开 13. 重新给开发板上电, 确保 LCD 显示 PIC32 HID Device (PIC32 HID 设备 ) 如果没有显示, 仔细检查编程步骤, 并在必要时重复这些步骤编译演示应用可以使用 Microchip C32 C 编译器编译本应用笔记提供的演示应用如果需要的话, 编译源文件的编译器也可以是您通常与 Microchip 单片机一起使用的编译器本应用笔记提供了一个预先定义好的鼠标 HID 项目文件, 可以使用 MPLAB IDE 打开它创建项目时使用的是支持 USB 的 PIC32 器件如果使用其他器件, 应该通过 MPLAB IDE 菜单命令选择相应的器件此外, 演示应用项目使用额外的包含路径, 它在 MPLAB IDE 的 Build Options ( 编译选项 ) 中定义需要下列包含路径 :.\..\Microchip\Include..\..\Microchip\Include DS01163A_CN 第 4 页 2009 Microchip Technology Inc.

5 表 5 列出了编译演示应用所必需的源文件表 5: 演示应用的项目文件文件目录说明 mouse_demo.c \PIC32 Solutions\usb_hid_mouse_device_demo 主演示源文件 mouse_dsc.c \PIC32 Solutions\usb_hid_mouse_device_demo 鼠标 HID USB 描述符 mouse_report.c \PIC32 Solutions\usb_hid_mouse_device_demo 鼠标演示的 HID 报告 HardwareProfile.h \PIC32 Solutions\usb_hid_mouse_device_demo PIC32 的硬件定义 usb_config.h \PIC32 Solutions\usb_hid_mouse_device_demo USB 特定的定义, 用于辅助函数 hid.c \PIC32 Solutions\Microchip\USB\hid_device_driver USB HID 源文件 hidpri.h \PIC32 Solutions\Microchip\USB\hid_device_driver 私有函数和宏定义 hid.h \PIC32 Solutions\Microchip\Include\USB USB HID 包含文件 hiddesc.h \PIC32 Solutions\Microchip\Include\USB HID 特定的描述符定义 hidreport.h \PIC32 Solutions\Microchip\Include\USB HID 报告结构宏和定义 usb_device.c \PIC32 Solutions\Microchip\USB USB 设备 API usb_hal.c \PIC32 Solutions\Microchip\USB USB 硬件 API usb_hal_core.c \PIC32 Solutions\Microchip\USB USB 硬件内核 API usb.h \PIC32 Solutions\Microchip\USB USB 最上层包含文件 usb_ch9.h \PIC32 Solutions\Microchip\Include\USB USB 定义与支持, 如 Universal Serial Bus Specification, Revision 2.0 第 9 章所述 usb_common.h \PIC32 Solutions\Microchip\Include\USB USB 公共定义 usb_device.h \PIC32 Solutions\Microchip\Include\USB USB 设备定义和 API 原型 usb_hal.h \PIC32 Solutions\Microchip\Include\USB USB 硬件支持 mstimer.c \PIC32 Solutions\Microchip\Common 1 毫秒定时器 ex16lcd.c \PIC32 Solutions\Microchip\Common Explorer 16 开发板 LCD mstimer.h \PIC32 Solutions\Microchip\Include 1 毫秒定时器定义 ex16lcd.h \PIC32 Solutions\Microchip\Include Explorer 16 开发板 LCD 定义 2009 Microchip Technology Inc. DS01163A_CN 第 5 页

6 下面是编译演示应用的概括性步骤这些步骤假定您熟悉 MPLAB IDE 并将使用 MPLAB IDE 来编译应用如果不是的话, 请参考您所用编程器的说明书, 了解如何创建和编译项目 1. 确保已经安装了 Microchip HID 功能驱动程序的源文件如果没有安装, 请参阅安装源文件 2. 启动 MPLAB IDE, 打开项目文件 3. 使用 MPLAB IDE 菜单命令编译项目注意, 如果源文件位于安装向导建议的目录结构中, 项目编译将很顺利如果移动了源文件, 或者把源文件安装到了其他位置, 必须重新创建项目或者修改现有的项目设定, 才能进行编译更多信息, 请参阅编译演示应用 4. 编译过程应该能够成功完成如若不然, 应确保您正确设置了 MPLAB IDE 和编译器应用特定的 USB 支持在使用 Microchip PIC32 USB 设备固件栈时,HID 演示实现了下列应用特定的表 : USB 描述符表端点配置表功能驱动程序表 USB 描述符表每个 USB 设备都必须提供一组描述符 ( 数据结构 ), 描述符对设备进行描述, 并向主机提供所用类驱动程序的详细信息至于这些描述符是如何正确提供的以及其中包含了什么信息, 在 Universal Serial Bus Specification, Revision 2.0 的第 9 章以及 Universal Serial Bus (USB) Device Class Definition for Human Devices (HID), Version 1.11 中有定义请参阅这些文档, 了解全部细节 USB 设备描述符可分为以下三类 : 设备配置字符串设备描述符标识设备类型, 给出可能配置的数量配置描述符说明所使用的接口和端点类型这类描述符还给出了类特定的描述符字符串描述符尽管通常是可选的提供了用户可读的信息, 主机可以显示这些信息演示应用的描述符表演示应用提供的描述符表在源文件 mouse_dsc.c 中, 其概要见附录 E: USB 描述符表定义可以修改演示应用的描述符表, 以添加其他接口或配置不过, 在尝试修改描述符表之前, 建议透彻理解 Universal Serial Bus Specification, Revision 2.0 的第 9 章以及其他适用的设备功能驱动程序特定的规范 DS01163A_CN 第 6 页 2009 Microchip Technology Inc.

7 端点配置表 USB 设备栈使用端点配置表, 按照描述符表定义的接口和备用设定, 正确配置全部端点端点配置表表明 : 应使用哪个功能驱动程序对发生在每个端点上的事件进行服务每个表项含有如下信息 : 最大包长度配置标志配置编号端点编号接口编号备用设定设备功能驱动程序表中指向端点处理例程的索引演示应用的端点配置表只有一项, 因为 HID 功能驱动程序只需要一个端点 (Interrupt-In, 中断输入端点 ) 在源文件 mouse_dsc.c 中可找到下表关于端点配置表的更多信息, 请参阅 AN1176 PIC32 USB 设备栈编程指南例 1: 端点配置表 const EP_CONFIG _EpConfigTlb[] = { { HID_MAX_REPORT_SIZE, // 最大包长度 USB_EP_TRANSMIT USB_EP_HANDSHAKE, // 配置为 Tx ( 发送 ) 并使能 // 握手 1, // 配置编号 1, // 端点编号 0, // 接口编号 0, // 备用设定 0 // 处理函数索引 } }; 2009 Microchip Technology Inc. DS01163A_CN 第 7 页

8 功能驱动程序表 Microchip PIC32 USB 设备栈使用一张表来管理对支持的功能驱动程序的访问, 因为一个设备可能实现的类或供应商特定的 USB 设备功能驱动程序不止一个表中的每一项都含有管理单个功能驱动程序所必需的信息每个表项中含有下列信息 : 初始化例程事件处理例程初始化标志演示应用的功能驱动程序表只有一项, 因为只有一个功能驱动程序 HID 在源文件 mouse_dsc.c 中可找到下表关于功能驱动程序表的更多信息, 请参阅 AN1176 PIC32 USB 设备栈编程指南例 2: 功能驱动程序表 const FUNC_DRV _DevFuncTbl[] = { { HIDInit, // 初始化例程 HIDEventHandler, // 事件处理例程 0 // 初始化标志 } }; DS01163A_CN 第 8 页 2009 Microchip Technology Inc.

9 HID 功能驱动程序概述 HID 描述符每个 USB 设备都有一个与之关联的描述符结构每个设备可能含有多个类 ( 比如 HID 等 ), 这些类在接口层中定义图 1 显示了描述符结构树, 可描述 HID 类设备 HID 描述符表明在它之后还有多少其他的 HID 类特定的描述符至少必须有一个报告描述符, 而物理描述符则是可选的报告描述符描述由设备生成的数据报告的格式和含义主机的 HID 类驱动程序使用类特定的请求, 装载 HID 报告描述符在初始化之后, 设备生成报告, 指出设备何时与人进行交互图 1: HID 功能驱动程序的 USB 描述符设备描述符字符串描述符配置描述符接口描述符端点描述符 HID 描述符报告描述符物理描述符 ( 可选的 ) 2009 Microchip Technology Inc. DS01163A_CN 第 9 页

10 HID 功能驱动程序 (USB 设备 ) 使用缺省管道 ( 控制 ) 或中断输入管道, 与 HID 类驱动程序 (USB 主机 ) 进行通信中断输入管道是 HID 功能驱动程序传输数据时必需的, 但是在需要时, 也可以使用可选的 Interrupt- Out ( 中断输出 ) 端点表 6: HID 端点配置将使用 Set Report( 设置报告 ) 请求, 要么通过中断输出端点, 要么通过缺省端点 ( 控制 ), 向设备传输主机生成的报告管道说明是否必需控制 ( 端点 0) USB 控制类请求代码以及查询的数据 ( 消息数据 ) 是中断输入数据输入, 数据来自设备是中断输出数据输出, 数据到设备否 HID 报告描述符 HID 报告描述符由称为条目 (item) 的信息片段组成每个条目描述报告数据的一个侧面紧跟在一个报告条目之后的是一个通用格式的一字节前缀, 然后是有效负载前缀字节含有标签类型有效负载长度图 2 给出了条目前缀字节的格式报告条目类型条目分为以下两类 : 短条目长条目短条目有可选的数据长度, 长度可以是或 4 字节图 3 给出了一个短条目的例子, 其有效负载长度是 2 字节长条目的数据长度最高可达 255 字节长类型的格式是一字节前缀 ( 这是 0xFE 的硬编码 ) 一字节的有效负载长度一字节的标签以及有效负载图 4 是长条目的格式图 2: HID 报告条目的前缀字节标签类型长度图 3: 2 字节长的 HID 报告短条目标签类型长度 [ 数据 ] [ 数据 ] 字节 : 图 4: HID 报告长条目格式数据长度长条目标签 [ 数据 ] 字节 : DS01163A_CN 第 10 页 2009 Microchip Technology Inc.

11 报告条目条目分为以下三类 : 输入条目输出条目特性 (feature) 条目输入条目类描述物理控制 ( 如键盘或鼠标等 ) 提供的数据之信息输出条目类描述要发送给设备的数据, 例如, 键盘上的 LED 可表明大写锁定 (Caps Lock) 键是否打开特性条目类描述能够发送给设备的配置信息下面是一个报告描述符的例子,HID 功能驱动程序演示中包含了这个报告描述符 : Usage Page (Generic Desktop), Usage (Mouse), Collection (Application), Usage (Pointer), Collection (Physical), Usage Page (Button Page), Usage Minimum (1), Usage Maximum (3), Logical Minimum (0), Logical Maximum (1), Report Count (3), Report Size (1), Input (Data, Variable, Absolute), Report Count (1), Report Size (5), Input (Constant), Usage Page (Generic Desktop), Usage (X), Usage (Y), Logical Minimum (-127), Logical Maximum (127), Report Count (2), Report Size (8), Input (Data, Variable, Relative), End Collection, End Collection 每一行表示 HID 功能驱动程序使用一个报告条目来定义图 5 中的报告结构报告条目 Usage Page (Generic Desktop) 和 Usage Page (Mouse) 告诉 HID 主机要定义的报告结构是针对桌面的, 且设备是鼠标报告中表示的数据由定义在 Collection (Physical) 中的条目来定义报告中三个按钮 ( 图 5 中 B1-B3) 的定义如下 : Usage Minimum (1) 和 Usage Maximum (3) 表示鼠标使用的按钮最少为 1, 最多为 3 Logical Minimum (0) 和 Logical Maximum (1) 是报告中将包含的值的范围对于鼠标的情形, 按钮或者是开 (1) 或者是关 (0) Report Count (3) 和 Report Size (1) 定义按钮数量和每个按钮的长度报告有 3 个按钮, 每个按钮用一个数据位表示 ( 报告中字节 0 的第 0-2 位 ) Input (Data, Variable, Absolute) 指出要发送哪类数据按钮是到主机的输入数据, 它们是变量, 是绝对的值 ( 开或关 ) 字节 0 的剩余位用零填充 Report Count (1) Report Size (5) Input (Constant) 鼠标的相对位置用字节 1 (X) 和字节 2 (Y) 表示 Usage (X) 和 Usage (Y) 表明后续的两个输入是位置 Logical Minimum (-127) 和 Logical Maximum (127) 是报告将含有的值的范围 Report Count (2) 和 Report Size (8) 定义位置数量和每个位置的长度 Input (Data, Variable, Relative) 指出要发送哪类数据位置是到主机的输入数据, 它们是变量, 报告的是相对于上次报告的位置 2009 Microchip Technology Inc. DS01163A_CN 第 11 页

12 图 5: 鼠标报告结构字节 : B3 B2 B1 X Y 按钮报告每隔 1 毫秒,HID 功能驱动程序就可以发送或接收一个 USB 事务一个或多个 USB 事务创建一个传输, 把有意义的数据传输给主机表 7 给出了 HID 报告类型表 7: 数据传输报告报告类型管道输入中断输入端点输出控制端点或可选的中断输出端点特性控制端点或可选的中断输出端点 HID 报告可能有也可能没有报告 ID, 它是报告的单字节前缀如果 HID 功能驱动程序能够生成多个报告, 那么报告 ID 是必需的, 因为要区分报告确保正确的数据处理如果在报告描述符中没有报告 ID 条目标签, 那么假设只存在一个输入输出和特性报告结构报告中所有的数据都使用小尾数 (little-endian) 格式表示 ( 见图 5) 输入报告用来向主机发送用户与设备交互的相关数据主机使用输出报告向设备发送控制数据, 比如打开大写锁定 LED 的命令主机使用特性报告对设备进行配置本演示只支持单个输入报告 DS01163A_CN 第 12 页 2009 Microchip Technology Inc.

13 结论本文档讨论了 HID 功能驱动程序, 相关的定制演示应用是使用 HID 功能驱动程序的鼠标演示通常, 管理通用串行总线需要开发人员处理进行设备标识控制和数据传输的协议不过, Microchip 已经对 USB 细节进行了处理, 并提供简单的 HID 功能驱动程序, 从而对于使用支持的 Microchip 单片机的开发人员而言, 应用的实现相当简单参考文献 Microchip 应用笔记 AN1176, PIC32 USB 设备栈编程指南 Microchip MPLAB IDE 集成开发环境, 许可证免费, 下载地址 : Universal Serial Bus Specification, Revision Universal Serial Bus (USB) Device Class Definition for Human Devices (HID), Version Microchip Technology Inc. DS01163A_CN 第 13 页

14 附录 A: MICROCHIP HID 功能驱动程序的相关性 HIDEventHandler USB 设备事件处理函数 Microchip HID 功能驱动程序应用笔记提供了一个事件处理例程, 它与 Microchip 应用笔记 AN1176 PIC32 USB 设备栈编程指南兼容此例程必须放入已定义的 USB 设备功能驱动程序表语法 PUBLIC BOOL HIDEventHandler(USB_EVENT event, void *data, UINT size) 参数 event 枚举数据类型, 指明已经发生的事件 data 指针, 指向事件相关的数据 size 事件相关的数据长度, 以字节为单位返回值如果成功的话, TRUE ; 如果失败, FALSE 说明 HIDInit USB 设备初始化处理函数初始化与 HID 功能驱动程序关联的所有数据结构此例程必须放入已定义的 USB 设备功能驱动程序表语法 PUBLIC BOOL HIDInit(unsigned long flags) 参数 flags 保留, 传递一个 0 返回值如果初始化通过, TRUE ; 否则 FALSE 说明 flags 参数作为 USB 设备功能驱动程序表的初始化标志参数传递注 : 关于 HIDEventHandler 和 HIDInit 的更多信息, 请参阅应用笔记 AN1176 PIC32 USB 设备栈编程指南 DS01163A_CN 第 14 页 2009 Microchip Technology Inc.

15 附录 B: HID 功能报告处理例程表要从 HID 类驱动程序输出报告, 需要提供为处理和获取报告所必需的例程表 _HidReportHandler 在 HID 源文件 (hid.c) 中每个表项含有下列信息 : 报告处理例程获取报告例程 API 定义报告处理例程调用例程, 以处理输出报告语法 BOOL < 报告处理例程 >(void *data, unsigned int size) 参数 data 指针, 指向已经从 HID 类驱动程序接收的数据 size 传输的数据长度, 以字节为单位返回值如果已经处理, TRUE ; 否则 FALSE 先决条件必须放置在 HID 源文件的 _HidReportHandler 结构中副作用无 2009 Microchip Technology Inc. DS01163A_CN 第 15 页

16 获取报告例程获取当前输入报告语法 UINT < 获取报告例程 >(void *data) 参数 data 指针, 指向例程存放报告的数据缓冲区返回值如果是 0, 表示出错 ; 否则, 返回报告长度 ( 以字节为单位 ) 先决条件必须放置在 HID 源文件的 _HidReportHandler 结构中副作用无 DS01163A_CN 第 16 页 2009 Microchip Technology Inc.

17 附录 C: HID 功能驱动程序宏在本应用笔记中, 嵌入式设备上的 USB HID 类提供了若干功能驱动程序宏, 以便为应用定制 USB HID 类 Microchip 嵌入式设备上的 USB HID 类提供了下列 HID 功能驱动程序宏 : mhidopentimer HID_TIMER_CONFIG mhidconfiginttimer HID_INT_CONFIG mhidenabletimerint mhiddisabletimerint mhidtimerinthandler mhidclearint HID_EP_IN HID_EP_IN_SIZE HID_MAX_REPORT_SIZE HID_NUM_REPORTS 2009 Microchip Technology Inc. DS01163A_CN 第 17 页

18 mhidopentimer 用途 : 缺省值 : 使用其外设库宏开打定时器 OpenTimer1 HID_TIMER_CONFIG 用途 : 定时器配置值缺省值 : (T1_ON) mhidconfiginttimer 用途 : 使用其外设库宏配置定时器中断缺省值 : ConfigIntTimer1 HID_INT_CONFIG 用途 : 定时器中断配置值缺省值 : (T1_INT_OFF T1_INT_PRIOR_2 T1_INT_SUB_PRIOR_1) mhidenabletimerint 用途 : 使用其外设库宏使能定时器中断缺省值 : EnableIntT1 mhiddisabletimerint 用途 : 使用其外设库宏禁止定时器中断缺省值 : DisableIntT1 mhidtimerinthandler 用途 : 定义中断处理函数缺省值 : Timer1IntHandler mhidclearint 用途 : 缺省值 : 使用其外设库宏清零定时器中断标志 mt1clearintflag HID_EP_IN 用途 : 端点, HID 功能驱动程序将发送来自该端点的输入报告缺省值 : 1 HID_EP_IN_SIZE 用途 : HID 功能驱动程序端点的大小, 以字节为单位缺省值 : 16 HID_MAX_REPORT_SIZE 用途 : 总报告结构的最大长度, 以字节为单位缺省值 : 64 HID_NUM_REPORTS 用途 : 支持的 HID 报告数目缺省值 : 1 DS01163A_CN 第 18 页 2009 Microchip Technology Inc.

19 附录 D: USB HID 功能驱动程序 API 本节描述了 HID 功能驱动程序 API API - HIDSendReport 发送一个输入报告给 HID 类驱动程序语法 BOOL HidSendReport(BYTE id, void *data, UINT size, BOOL change) 参数 id 报告 ID ; 如果没有使用的报告 ID, 这个值为 0 data 指针, 指向要发送的报告数据 size 要发送的数据长度 change 数据是否已经改变返回值如果数据发送请求已经得到服务, TRUE ; 否则 FALSE 先决条件已经初始化 USB 设备栈和 HID 副作用无示例 // 发送一个报告 BYTE report[4]; report[0] = M ; report[1] = C ; report[2] = H ; report[3] = P ; if(!hidsendreport(0, report, 4, FALSE) { // 处理发送错误 } 2009 Microchip Technology Inc. DS01163A_CN 第 19 页

20 附录 E: USB 描述符表定义 HID 功能驱动程序定义了它的描述符表, 如 HID 描述符所述, 描述符表的值见下列各表 : 表 E-1: 设备描述符字段说明 HID 功能驱动程序值 blength 描述符的大小 12h bdescriptortype 类型, 始终是 USB 设备描述符 1 bcdusb USB 规范版本, BCD 码格式 200h bdeviceclass 设备类代码 0 bdevicesubclass 设备子类代码 0 bdeviceprotocol 设备协议 0 bmaxpacketsize 端点 0 最大包长度 10h idvendor 供应商 ID (VID) 4D8h idproduct 产品 ID (PID) Dh bcddevice 设备版本号, BCD 码格式 1 imanufacturer 制造商名称字符串索引 1 iproduct 产品描述字符串索引 2 iserialnum 产品序列号字符串索引 0 bnumconfigurations 支持的配置数量 1 表 E-2: 配置描述符字段说明 HID 功能驱动程序值 blength 描述符的大小 9 bdescriptortype 类型, 始终是 USB 配置描述符 2 wtotallength 全部描述符的总长度 22h bnuminterfaces 接口数量 1 bconfiguration/value ID 值 1 iconfiguration 字符串描述符的索引 0 bmattributes reserved_zero 始终为 0 0 remote_waking 1 ( 如果设备支持远程唤醒 ) 1 self_powered 1 ( 如果设备是自供电的 ) 0 reserved_one 始终为 1 1 bmaxpower ma/2 ( 例如, 100 ma = 50) 50 DS01163A_CN 第 20 页 2009 Microchip Technology Inc.

21 表 E-3: 接口描述符字段说明 HID 功能驱动程序值 blength 描述符的大小 9 bdescriptortype 类型, 始终是 USB 接口描述符 4 binterfacenumber 接口 ID 编号 0 balternatesetting 备用接口设置的 ID 编号 0 bnumendpoints 此接口中端点的数量 1 binterfaceclass USB 接口类 ID 3 binterfacesubclass USB 接口子类 ID 1 binterfaceprotocol USB 接口协议 ID 2 iinterface 接口描述字符串索引 0 表 E-4: HID 接口描述符字段说明 HID 功能驱动程序值 blength 描述符的大小 9 bdescriptortype 类型, 始终是 USB HID 接口描述符 21h bcdhid HID 规范版本, BCD 码格式 101h bcountrycode 本地化硬件的国家代码 0 bnumdescriptors 类描述符的数量, 最小为 1 1 表 E-5: HID 类接口描述符字段说明 HID 功能驱动程序值 bdescriptortype 类描述符的 ID 类型 22h bdescriptorlength 描述符 ( 即, HID 报告 ) 的总长度 32h 表 E-6: 端点描述符字段说明 HID 功能驱动程序值 blength 描述符的大小 7 bdescriptortype 类型, 始终是 USB 端点描述符 5 bendpointaddress ep_num 端点编号 1 reserved 始终为 0 0 direction IN 或 OUT 1 bmattribute transfer_type 传输类型 1 synch_type 同步类型 0 usage_type 用法类型 0 reserved 始终为 0 0 wmaxpacketsize 端点能处理的最大包 16 binterval 查询端点获取数据的时间间隔 Microchip Technology Inc. DS01163A_CN 第 21 页

22 表 E-7: 序列号字符串描述符字段说明 HID 功能驱动程序值 blength 描述符的大小 4 bdescriptortype 类型, 始终是 USB 字符串描述符 3 wlangid[] 字符串 409h 表 E-8: 制造商字符串描述符字段说明 HID 功能驱动程序值 blength 描述符的大小 34h bdescriptortype 类型, 始终是 USB 字符串描述符 3 wlangid[] 字符串 Microchip Technology Inc. 表 E-9: 产品字符串描述符字段说明 HID 功能驱动程序值 blength 描述符的大小 2Eh bdescriptortype 类型, 始终是 USB 字符串描述符 3 wlangid[] 字符串 Mouse In a Circle Demo DS01163A_CN 第 22 页 2009 Microchip Technology Inc.

23 软件许可协议 Microchip Technology Incorporated ( 以下简称本公司 ) 在此提供的软件旨在向本公司客户提供专门用于 Microchip 生产的产品的软件本软件为本公司及 / 或其供应商所有, 并受到适用的版权法保护版权所有使用时违反前述约束的用户可能会依法受到刑事制裁, 并可能由于违背本许可的条款和条件而承担民事责任本软件是按现状提供的任何形式的保证, 无论是明示的暗示的或法定的, 包括但不限于有关适销性和特定用途的暗示保证, 均不适用于本软件对于在任何情况下因任何原因造成的特殊的附带的或间接的损害, 本公司概不负责. 附录 F: HID 功能驱动程序的源代码 Microchip 嵌入式设备上的 USB HID 类驱动程序的完整源代码是在免费许可证协议的基础上提供它以一个档案文件的形式提供, 可以从 Microchip 公司网站下载, 地址是 : 下载档案文件之后, 应查阅版本说明, 了解当前的版本号以及软件的修改历史 2009 Microchip Technology Inc. DS01163A_CN 第 23 页

24 版本历史版本 A (2008 年 2 月 ) 这是本文档的初始版本 DS01163A_CN 第 24 页 2009 Microchip Technology Inc.

请注意以下有关 Microchip 器件代码保护功能的要点 : Microchip 的产品均达到 Microchip 数据手册中所述的技术指标 Microchip 确信 : 在正常使用的情况下, Microchip 系列产品是当今市场上同类产品中最安全的产品之一目前, 仍存在着恶意甚至是非法破坏代码保护功能的行为就我们所知, 所有这些行为都不是以 Microchip

25 请注意以下有关 Microchip 器件代码保护功能的要点 : Microchip 的产品均达到 Microchip 数据手册中所述的技术指标 Microchip 确信 : 在正常使用的情况下, Microchip 系列产品是当今市场上同类产品中最安全的产品之一目前, 仍存在着恶意甚至是非法破坏代码保护功能的行为就我们所知, 所有这些行为都不是以 Microchip 数据手册中规定的操作规范来使用 Microchip 产品的这样做的人极可能侵犯了知识产权 Microchip 愿与那些注重代码完整性的客户合作 Microchip 或任何其他半导体厂商均无法保证其代码的安全性代码保护并不意味着我们保证产品是牢不可破的代码保护功能处于持续发展中 Microchip 承诺将不断改进产品的代码保护功能任何试图破坏 Microchip 代码保护功能的行为均可视为违反了数字器件千年版权法案 (Digital Millennium Copyright Act) 如果这种行为导致他人在未经授权的情况下, 能访问您的软件或其他受版权保护的成果, 您有权依据该法案提起诉讼, 从而制止这种行为提供本文档的中文版本仅为了便于理解请勿忽视文档中包含的英文部分, 因为其中提供了有关 Microchip 产品性能和使用情况的有用信息 Microchip Technology Inc. 及其分公司和相关公司各级主管与员工及事务代理机构对译文中可能存在的任何差错不承担任何责任建议参考 Microchip Technology Inc. 的英文原版文档本出版物中所述的器件应用信息及其他类似内容仅为您提供便利, 它们可能由更新之信息所替代确保应用符合技术规范, 是您自身应负的责任 Microchip 对这些信息不作任何明示或暗示书面或口头法定或其他形式的声明或担保, 包括但不限于针对其使用情况质量性能适销性或特定用途的适用性的声明或担保 Microchip 对因这些信息及使用这些信息而引起的后果不承担任何责任如果将 Microchip 器件用于生命维持和 / 或生命安全应用, 一切风险由买方自负买方同意在由此引发任何一切伤害索赔诉讼或费用时, 会维护和保障 Microchip 免于承担法律责任, 并加以赔偿在 Microchip 知识产权保护下, 不得暗中或以其他方式转让任何许可证商标 Microchip 的名称和徽标组合 Microchip 徽标 Accuron dspic KEELOQ KEELOQ 徽标 MPLAB PIC PICmicro PICSTART rfpic SmartShun 和 UNI/O 均为 Microchip Technology Inc. 在美国和其他国家或地区的注册商标 FilterLab Linear Active Thermistor MXDEV MXLAB SEEVAL SmartSensor 和 The Embedded Control Solutions Company 均为 Microchip Technology Inc. 在美国的注册商标 Analog-for-the-Digital Age Application Maestro CodeGuard dspicdem dspicdem.net dspicworks dsspeak ECAN ECONOMONITOR FanSense In-Circuit Serial Programming ICSP ICEPIC Mindi MiWi MPASM MPLAB Certified 徽标 MPLIB MPLINK mtouch nanowatt XLP PICkit PICDEM PICDEM.net PICtail PIC 32 徽标 PowerCal PowerInfo PowerMate PowerTool REAL ICE rflab Select Mode Total Endurance TSHARC WiperLock 和 ZENA 均为 Microchip Technology Inc. 在美国和其他国家或地区的商标 SQTP 是 Microchip Technology Inc. 在美国的服务标记在此提及的所有其他商标均为各持有公司所有 2009, Microchip Technology Inc. 版权所有 Microchip 位于美国亚利桑那州 Chandler 和 Tempe 与位于俄勒冈州 Gresham 的全球总部设计和晶圆生产厂及位于美国加利福尼亚州和印度的设计中心均通过了 ISO/TS-16949:2002 认证公司在 PIC MCU 与 dspic DSC KEELOQ? 跳码器件串行 EEPROM 单片机外设非易失性存储器和模拟产品方面的质量体系流程均符合 ISO/TS :2002 此外, Microchip 在开发系统的设计和生产方面的质量体系也已通过了 ISO 9001:2000 认证 2009 Microchip Technology Inc. DS01163A_CN 第 25 页

26 全球销售及服务网点美洲亚太地区亚太地区欧洲公司总部 Corporate Office 2355 West Chandler Blvd. Chandler, AZ Tel: Fax: 技术支持 : 网址 : 亚特兰大 Atlanta Duluth, GA Tel: Fax: 波士顿 Boston Westborough, MA Tel: Fax: 芝加哥 Chicago Itasca, IL Tel: Fax: 克里夫兰 Cleveland Independence, OH Tel: Fax: 达拉斯 Dallas Addison, TX Tel: Fax: 底特律 Detroit Farmington Hills, MI Tel: Fax: 科科莫 Kokomo Kokomo, IN Tel: Fax: 洛杉矶 Los Angeles Mission Viejo, CA Tel: Fax: 圣克拉拉 Santa Clara Santa Clara, CA Tel: Fax: 加拿大多伦多 Toronto Mississauga, Ontario, Canada Tel: Fax: 亚太总部 Asia Pacific Office Suites , 37th Floor Tower 6, The Gateway Harbour City, Kowloon Hong Kong Tel: Fax: 中国 - 北京 Tel: Fax: 中国 - 成都 Tel: Fax: 中国 - 香港特别行政区 Tel: Fax: 中国 - 南京 Tel: Fax: 中国 - 青岛 Tel: Fax: 中国 - 上海 Tel: Fax: 中国 - 沈阳 Tel: Fax: 中国 - 深圳 Tel: Fax: 中国 - 武汉 Tel: Fax: 中国 - 厦门 Tel: Fax: 中国 - 西安 Tel: Fax: 中国 - 珠海 Tel: Fax: 台湾地区 - 高雄 Tel: Fax: 台湾地区 - 台北 Tel: Fax: 澳大利亚 Australia - Sydney Tel: Fax: 印度 India - Bangalore Tel: Fax: 印度 India - New Delhi Tel: Fax: 印度 India - Pune Tel: Fax: 日本 Japan - Yokohama Tel: Fax: 韩国 Korea - Daegu Tel: Fax: 韩国 Korea - Seoul Tel: Fax: 或马来西亚 Malaysia - Kuala Lumpur Tel: Fax: 马来西亚 Malaysia - Penang Tel: Fax: 菲律宾 Philippines - Manila Tel: Fax: 新加坡 Singapore Tel: Fax: 泰国 Thailand - Bangkok Tel: Fax: 奥地利 Austria - Wels Tel: Fax: 丹麦 Denmark-Copenhagen Tel: Fax: 法国 France - Paris Tel: Fax: 德国 Germany - Munich Tel: Fax: 意大利 Italy - Milan Tel: Fax: 荷兰 Netherlands - Drunen Tel: Fax: 西班牙 Spain - Madrid Tel: Fax: 英国 UK - Wokingham Tel: Fax: 台湾地区 - 新竹 Tel: Fax: /26/09 DS01163A_CN 第 26 页 2009 Microchip Technology Inc.

untitled

untitled C 8051 MCU SPI EEPROM Alexandru Valeanu Microchip Technology Inc. Microchip Technology 25XXX EEPROM SPI 25XXX EEPROM SO 25XXX EEPROM 3MHz 20 MHz SPI HOLD 25XXX EEPROM EEPROM MCU HOLD 25XXX EEPROM SPI EEPROM