【经验分享】鼠标HID例程简析（中）

FSL_TICS_ZP

鼠标HID例程简析

    今天紧接《鼠标HID例程简析（上）》一文，继续向大家介绍鼠标HID例程的未完的内容。

    TestApp_Init(void)

TestApp_Init()函数包含USB_Class_HID_Init（）函数实现USB接口的初始化，包括初始化各式USB类结构数据，并且通过其内部的USB_Class_Init（）和USB_Device_Init（）函数可分别初始化Class driver层中的Common class模块、Framework模块。

1. *****************************************************************************
   
2. * This function starts the Mouse Application
   
3. *****************************************************************************/
   
4. 
   
5. void TestApp_Init(void)
   
6. {
   
7.     uint_8   error;
   
8. 
   
9.     rpt_buf[3] = 0x00; /* always zero */
   
10. 
    
11.     *((uint_32_ptr)rpt_buf) = 0;
    
12.     *((uint_32_ptr)null_buf) = 0;
    
13.     DisableInterrupts;
    
14.     #if (defined _MCF51MM256_H) || (defined _MCF51JE256_H)
    
15.      usb_int_dis();
    
16.     #endif        
    
17. 
    
18.     error = USB_Class_HID_Init(CONTROLLER_ID, USB_App_Callback, NULL,
    
19.                             USB_App_Param_Callback);//USB接口初始化
    
20.     UNUSED(error);
    
21.    
    
22.     EnableInterrupts;
    
23.     #if (defined _MCF51MM256_H) || (defined _MCF51JE256_H)
    
24.      usb_int_en();
    
25.     #endif        
    
26. }
    

复制代码

      USB_Class_HID_Init（）

本人在《FSL USB Stack简介》一文中，已向大家介绍过USB Stack 架构中各层的组成和相互之间的关系，如图1所示。

图1 FSL USB Stack架构

       Framework模块：负责处理 USB device 在枚举过程中的控制端点接到的来自Host的各式请求。

       Commonclass 模块：负责处理所有USB 类都会发生的suspend/resume、reset、stall、SOF。当检测到事件发送时，如USB总线复位、枚举成功、配置变换、数据接收或发生完成等，Common class 模块都会通过传送Callback通知Class specific 模块或者USB Application层。

      Classspecific模块用于处理控制端点外的端点与Host通信的事宜，在这类端点上进行字符发送和接收都受Class specific模块管理，同时Class specific模块还会处理在控制端点上接收到的特定请求，如本例程中的HID类的特定请求：Get_Report、Set_Report 、Get_Idle、 Set_Idle 、Get_Protocol 、Set_Protocol。

     USB_Class_HID_Init（）函数的函数指针数：hid_class_callback、vendor_req_callback、param_callback分别对应着处理USB事件，Vendor特定请求，USB类特定请求。

1. ******************************************************************************
   
2. *This function initializes the HID Class layer and layers it is dependent on
   
3. *****************************************************************************/
   
4. uint_8 USB_Class_HID_Init (
   
5.     uint_8    controller_ID,                /* [IN] Controller ID */
   
6.     USB_CLASS_CALLBACK hid_class_callback,  /* [IN] HID Class Callback */
   
7.     USB_REQ_FUNC       vendor_req_callback, /* [IN] Vendor Request Callback */
   
8.     USB_CLASS_SPECIFIC_HANDLER_FUNC param_callback
   
9.                                         /* [ IN] HID Class requests Callback */
   
10. )
    
11. {
    
12.     uint_8 index,status = USB_OK;
    
13.     USB_ENDPOINTS *ep_desc_data = (USB_ENDPOINTS *)
    
14.         USB_Desc_Get_Endpoints(controller_ID);
    
15.    
    
16. #ifndef COMPOSITE_DEV
    
17.     /* Initialize the device layer*/
    
18.     status = _usb_device_init(controller_ID, NULL,
    
19.         (uint_8)(ep_desc_data->count+1), TRUE);
    
20.     if(status == USB_OK)
    
21.     {
    
22.         /* Initialize the generic class functions */
    
23.         status = USB_Class_Init(controller_ID,USB_Class_Hid_Event,
    
24.             USB_Other_Requests);
    
25. 
    
26.         if(status == USB_OK)
    
27.         {
    
28. #endif
    
29.             g_hid_endpoint_data.count = ep_desc_data->count;
    
30. 
    
31.             for(index = 0; index < ep_desc_data->count; index++)
    
32.             {
    
33.                 g_hid_endpoint_data.ep[index].endpoint =
    
34.                     ep_desc_data->ep[index].ep_num;
    
35.                 g_hid_endpoint_data.ep[index].type =
    
36.                     ep_desc_data->ep[index].type;
    
37.                 g_hid_endpoint_data.ep[index].bin_consumer = 0x00;
    
38.                 g_hid_endpoint_data.ep[index].bin_producer = 0x00;
    
39.             }
    
40. 
    
41.             /* save the HID class callback pointer */
    
42.             g_hid_class_callback = hid_class_callback;
    
43. 
    
44.             /* save the vendor request callback pointer */
    
45.             g_vendor_req_callback = vendor_req_callback;
    
46. 
    
47.             /* Save the callback to ask application for class specific params*/
    
48.             g_param_callback = param_callback;
    
49. #ifndef COMPOSITE_DEV
    
50.         }
    
51.     }
    
52. #endif
    
53.     return status;
    
54. }
    

复制代码

       USB_Class_Hid_Event（）

USB_Class_Hid_Event对应着处理各式USB事件，如USB 总线复位、枚举成功、配置变换、数据接收或发生完成。

1. ***************************************************************************
   
2. @name  USB_Class_Hid_Event
   
3.   The funtion initializes the HID endpoints when Enumeration complete event is
   
4.   received
   
5. ***************************************************************************/
   
6. void USB_Class_Hid_Event (
   
7.     uint_8 controller_ID,   /* [IN] Controller ID */
   
8.     uint_8 event,           /* [IN] Event Type */
   
9.     void* val               /* [IN] Pointer to configuration Value */
   
10. )
    
11. {
    
12.     uint_8 index;
    
13. 
    
14.     if(event == USB_APP_ENUM_COMPLETE)
    
15.     {
    
16.         uint_8 index_num = 0;
    
17.         uint_8 count = 0,ep_count = 0;
    
18.         USB_ENDPOINTS *ep_desc_data;  
    
19.         
    
20. #ifdef COMPOSITE_DEV
    
21.         DEV_ARCHITECTURE_STRUCT_PTR dev_arc_ptr;
    
22.         CLASS_ARC_STRUCT_PTR dev_class_ptr;   
    
23.         dev_arc_ptr = (DEV_ARCHITECTURE_STRUCT *)USB_Desc_Get_Class_Architecture(controller_ID);   
    
24.         for(count = 0; count < dev_arc_ptr->cl_count; count++)
    
25.         {
    
26.             dev_class_ptr = (CLASS_ARC_STRUCT_PTR)dev_arc_ptr->value[count];
    
27.             /* Initializes sub_classes */
    
28.             ep_count = dev_class_ptr->value[0];
    
29.             if(dev_class_ptr->class_type == 0x03/*HID_CC*/)
    
30.                 break;
    
31.             index_num +=dev_class_ptr->value[0];
    
32.         }
    
33.         /* get the endpoints from the descriptor module */
    
34.         ep_desc_data = (USB_ENDPOINTS *)USB_Desc_Get_Endpoints(controller_ID);
    
35. #else
    
36.         /* get the endpoints from the descriptor module */
    
37.         ep_desc_data = (USB_ENDPOINTS *)USB_Desc_Get_Endpoints(controller_ID);
    
38.                                        
    
39.                 ep_count = ep_desc_data->count;
    
40. #endif
    
41.                 /* deinitialize all endpoints in case they were initialized */
    
42.                 for(count=index_num;count<ep_count+index_num;count++)
    
43.                 {   
    
44.                         USB_EP_STRUCT_PTR ep_struct_ptr=
    
45.                                 (USB_EP_STRUCT_PTR) (&ep_desc_data->ep[count]);
    
46.                         (void)_usb_device_deinit_endpoint(&controller_ID,
    
47.                                 ep_struct_ptr->ep_num, ep_struct_ptr->direction);  
    
48.                 }
    
49. 
    
50.         /* intialize all non control endpoints */
    
51.         for(count=index_num;count<ep_count+index_num;count++)
    
52.         {
    
53.             USB_EP_STRUCT_PTR ep_struct=
    
54.                 (USB_EP_STRUCT_PTR)&ep_desc_data->ep[count];
    
55. 
    
56.             (void)_usb_device_init_endpoint(&controller_ID, ep_struct->ep_num,
    
57.                             ep_struct->size, ep_struct->direction, ep_struct->type,
    
58.                             TRUE);
    
59. 
    
60.             /* register callback service for the endpoint */
    
61.             (void)_usb_device_register_service(controller_ID,
    
62.                                   (uint_8)(USB_SERVICE_EP0+ep_struct->ep_num),
    
63.                                                              USB_Service_Hid);
    
64. 
    
65. 
    
66.             /* set the EndPoint Status as Idle in the device layer */
    
67.             (void)_usb_device_set_status(&controller_ID,
    
68.                 (uint_8)(USB_STATUS_ENDPOINT | ep_struct->ep_num |
    
69.                 (ep_struct->direction << USB_COMPONENT_DIRECTION_SHIFT)),
    
70.                 USB_STATUS_IDLE);
    
71.         }
    
72. 
    
73.     }
    
74.     else if((event == USB_APP_BUS_RESET) || (event == USB_APP_CONFIG_CHANGED))
    
75.     {
    
76.         /* clear producer and consumer on reset */
    
77.         for(index = 0; index < g_hid_endpoint_data.count; index++)
    
78.         {
    
79.             g_hid_endpoint_data.ep[index].bin_consumer = 0x00;
    
80.             g_hid_endpoint_data.ep[index].bin_producer = 0x00;
    
81.             g_hid_endpoint_data.ep[index].queue_num    = 0x00;
    
82.         }
    
83.     }
    
84. 
    
85.     if(g_hid_class_callback != NULL)
    
86.     {
    
87.         /* notify the application of the event */
    
88.         g_hid_class_callback(controller_ID, event, val);
    
89.     }
    
90. 
    
91. }
    

复制代码

USB_Other_Requests（）

USB_Other_Requests（）函数用于处理Host发送来的HID类特定请求和Vendor特定请求，如，Get_Report、Set_Report 、Get_Idle、 Set_Idle 、Get_Protocol、Set_Protocol。

1. ******************************************************************************
   
2. * Handles HID Class requests and forwards vendor specific request to the
   
3. * application
   
4. *****************************************************************************/
   
5. #ifndef COMPOSITE_DEV
   
6. static uint_8 USB_Other_Requests
   
7. #else
   
8. uint_8 USB_HID_Other_Requests
   
9. #endif
   
10. (
    
11.     uint_8 controller_ID,               /* [IN] Controller ID */
    
12.     USB_SETUP_STRUCT * setup_packet,    /*[IN] Setup packet received */
    
13.     uint_8_ptr *data,                   /* [OUT] Data to be send back */
    
14.     USB_PACKET_SIZE *size               /* [OUT] Size to be returned*/
    
15. )
    
16. {
    
17.     uint_8 index;
    
18.     uint_8 status = USBERR_INVALID_REQ_TYPE;
    
19.     uint_8 rpt_buf[REPORT_SIZE];/* buffer to send in case of get report req */
    
20.     *((uint_32_ptr)rpt_buf) = 0;
    
21. 
    
22.     if((setup_packet->request_type & USB_REQUEST_CLASS_MASK) ==
    
23.         USB_REQUEST_CLASS_CLASS)
    
24.     {
    
25.         /* class request so handle it here */
    
26.         /* index == 0 for get/set idle, index == 1 for get/set protocol */
    
27.         index = (uint_8)((setup_packet->request - 2) &
    
28.             USB_HID_REQUEST_TYPE_MASK);
    
29. 
    
30.         status = USB_OK;
    
31.         /* point to the data which comes after the setup packet */
    
32.         *data = ((uint_8*)setup_packet) + USB_SETUP_PKT_SIZE;
    
33.         *size = 0;
    
34.         /* handle the class request */
    
35.         switch(setup_packet->request)
    
36.         {
    
37.             case USB_HID_GET_REPORT_REQUEST :
    
38.                 /*set the data pointer to the buffer to send */
    
39.                 *data = &rpt_buf[0];
    
40.                 if(*size > REPORT_SIZE) *size = REPORT_SIZE;
    
41.                 break;
    
42. 
    
43.             case USB_HID_SET_REPORT_REQUEST :
    
44.                 for(index = 0; index < REPORT_SIZE; index++)
    
45.                 {   /* copy the data sent by host in the buffer */
    
46.                   rpt_buf[index] = *(*data + index);
    
47.                 }
    
48.                 break;
    
49. 
    
50.             case USB_HID_GET_IDLE_REQUEST :
    
51.                 /* point to the current idle rate */
    
52.                 *data = &g_class_request_params[index];
    
53.                 *size = CLASS_REQ_DATA_SIZE;
    
54.                 break;
    
55. 
    
56.             case USB_HID_SET_IDLE_REQUEST :
    
57.                 /* set the idle rate sent by the host */
    
58.                 g_class_request_params[index] =(uint_8)((setup_packet->value
    
59.                     & MSB_MASK) >> HIGH_BYTE_SHIFT);
    
60.                 break;
    
61. 
    
62.             case USB_HID_GET_PROTOCOL_REQUEST :
    
63.                 /* point to the current protocol code
    
64.                             0 = Boot Protocol
    
65.                             1 = Report Protocol*/
    
66.                 *data = &g_class_request_params[index];
    
67.                 *size = CLASS_REQ_DATA_SIZE;
    
68.                 break;
    
69. 
    
70.             case USB_HID_SET_PROTOCOL_REQUEST :
    
71.                 /* set the protocol sent by the host
    
72.                              0 = Boot Protocol
    
73.                              1 = Report Protocol*/
    
74.                 g_class_request_params[index] = (uint_8)(setup_packet->value);
    
75.                 break;
    
76.             default :
    
77.                 break;
    
78.         }
    
79. 
    
80.         if(g_param_callback != NULL)
    
81.         {
    
82.             /*
    
83.                handle callback if the application has supplied it
    
84.                set the size of the transfer from the setup packet
    
85.             */
    
86.             *size = (USB_PACKET_SIZE)setup_packet->length;
    
87. 
    
88.             /* notify the application of the class request.
    
89.                give control to the application */
    
90.             status = g_param_callback(setup_packet->request,/* request type */
    
91.                 setup_packet->value,
    
92.                 setup_packet->index, /* Application needs to know which Interface is being communicated with */
    
93.                 data,/* pointer to the data */
    
94.                 size);/* size of the transfer */
    
95.         }
    
96. 
    
97.     }
    
98.     else if((setup_packet->request_type & USB_REQUEST_CLASS_MASK) ==
    
99.         USB_REQUEST_CLASS_VENDOR)
    
100.     {
     
101.         /* vendor specific request  */
     
102.         if(g_vendor_req_callback != NULL)
     
103.         {
     
104.             status = g_vendor_req_callback(controller_ID, setup_packet,data,
     
105.                 size);
     
106.         }
     
107.     }
     
108.     return status;
     
109. }
     

复制代码

参考文献：

[1] Freescale USB DeviceStack Users Guide

[2] Freescale USB StackDevice API Reference Manual

[3] FSL USB Stack v4.1.1

[size=19.0909080505371px]完整文档下载：

[size=19.0909080505371px] 鼠标HID例程(中).pdf (380.4 KB, 下载次数: 116)

2014-9-16 17:36 上传

点击文件名下载附件

阅读全文

xinyinzhou

感谢楼主对于USB stack的详细讲解，受教了。

FSL_TICS_ZP

未完待续，
不足之处恳请指正，同时也欢迎大家分享自己的经验。

Jay-295455

又有更新，谢谢斑竹分享！

FSL_TICS_ZJJ

大家以后有好的经验，也欢迎分享出来。

FSL_TICS_ZP

Jay-295455 发表于 2014-9-16 17:42
又有更新，谢谢斑竹分享！

谢谢支持，如有疑问，请在帖子后面留贴！