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

FSL_TICS_ZP

鼠标HID例程简析

     大家好，此文内容紧跟《FSL USB Stack 简介》一文，如果网友们先前没有浏览过《FSL USB Stack 简介》，建议先下载浏览，然后再浏览本篇内容。本篇是以飞思卡尔的USB协议栈Freescale USB Stack v4.1.1中的鼠标HID例程为例，介绍USB Stack层式架构中的USB Application、HID Class Drivers 和 USB Drivers是如何各司其职，相互配合确保例程，本例程路径：<dir_stall>\USBFreescale USB Stack v4.1.1\ Source\Device\app\hid\cw10\kinetis_l2k
1.        USB Stack文件介绍
     图1为在CW10.6中打开的kinetis_l2k例程， 从中可看出，在USB Stack层式架构中，USB Application、HID Class Drivers 和 USB Drivers都有属于本层的文件，表一则对各层的文件进行了归纳。

图1 USB Stack 文件
表一

2.        鼠标HID例程代码
        主程序

1. *****************************************************************************
   
2. * This function initializes the system, enables the interrupts and calls the
   
3. * application
   
4. *****************************************************************************/
   
5. #ifdef __GNUC__
   
6. int main(void)
   
7. #else
   
8. void main(void)
   
9. #endif
   
10. {
    
11.         /* Initialize the system */
    
12.     SYS_Init(); //时钟配置：PEE模式，CORE_CLOCK、SYSTEM_CLOCK、BUS_CLOCK、FLASH_CLOCK为48MHz
    
13. 
    
14. #ifdef SERIAL_DEBUG
    
15.     sci_init();
    
16. #endif
    
17. #ifndef _SERIAL_AGENT_
    
18.     /* Initialize USB module */
    
19. #if HIGH_SPEED_DEVICE
    
20.     USB_Init(ULPI);
    
21. #else
    
22.     USB_Init(MAX3353);//USB模块初始化
    
23. #endif
    
24. #else
    
25.     SIM_SOPT2  |= (SIM_SOPT2_USBSRC_MASK | SIM_SOPT2_PLLFLLSEL_MASK);
    
26. #endif
    
27.     /* Initialize GPIO pins */
    
28.     GPIO_Init(); //按键引脚初始化：PTA4、PTC3
    
29. 
    
30. #if MAX_TIMER_OBJECTS
    
31.     (void)TimerQInitialize(0);
    
32. #endif
    
33.    
    
34.     /* Initialize the USB Test Application */
    
35.     TestApp_Init();//鼠标HID应用运行开始，内含USB_Class_HID_Init（）函数
    
36. 
    
37.     while(TRUE)
    
38.     {
    
39.             Watchdog_Reset();
    
40.             /* Call the application task */
    
41.             TestApp_Task();//应用任务函数
    
42.     }
    
43. 
    
44. #ifdef __GNUC__
    
45.     return 0;
    
46. #endif
    
47. }
    

复制代码

pll_init（）
SYS_Init（）函数中包含pll_init()函数用于配置PEE时钟模式和
各个时钟源的频率。

1. static int pll_init()
   
2. {
   
3. #elif (defined MCU_MKL25Z4)   
   
4.     /* Update system prescalers */
   
5.     SIM_CLKDIV1  = SIM_CLKDIV1_OUTDIV4(1);
   
6.     SIM_CLKDIV1 |= SIM_CLKDIV1_OUTDIV1(1);
   
7.     /* First FEI must transition to FBE mode
   
8.         Enable external oscillator, RANGE=02, HGO=, EREFS=, LP=, IRCS= */
   
9.     MCG_C2 = MCG_C2_RANGE0(2) | MCG_C2_EREFS0_MASK | MCG_C2_IRCS_MASK;
   
10. 
    
11.     /* Select external oscillator and Reference Divider and clear IREFS
    
12.      * to start external oscillator
    
13.      * CLKS = 2, FRDIV = 3, IREFS = 0, IRCLKEN = 0, IREFSTEN = 0
    
14.      */
    
15.     MCG_C1 = MCG_C1_CLKS(2) | MCG_C1_FRDIV(3);
    
16.    
    
17.     /* MCG_C4: DMX32=0,DRST_DRS=0 */
    
18.     MCG_C4 &= (uint8_t)~(uint8_t)0xE0U;
    
19.    
    
20.     /* MCG_C5: ??=0,PLLCLKEN=0,PLLSTEN=1,PRDIV=0x3, external clock reference = 8/4 = 2MHz */
    
21.     MCG_C5 = (uint8_t)0x23U;
    
22.    
    
23.     /* MCG_C6: LOLIE=0,PLLS=0,CME=0,VDIV=0x18 */
    
24.     MCG_C6 = (uint8_t)0x18U;
    
25.    
    
26.     while((MCG_S & MCG_S_IREFST_MASK) != 0x00U) { /* Check that the source of the FLL reference clock is the external reference clock. */
    
27.     }
    
28.    
    
29.     while((MCG_S & 0x0CU) != 0x08U) {    /* Wait until external reference clock is selected as MCG output */
    
30.     }
    
31.    
    
32.     /* Switch to PBE Mode */
    
33.     /* MCG_C1: CLKS=2,FRDIV=3,IREFS=0,IRCLKEN=0,IREFSTEN=0 */
    
34.     MCG_C1 = MCG_C1_CLKS(2) | MCG_C1_FRDIV(3);
    
35.    
    
36.     /* MCG_C2: ??=0,??=0,RANGE=2,HGO=0,EREFS=0,LP=0,IRCS=1 */
    
37.     MCG_C2 = MCG_C2_RANGE0(2) | MCG_C2_EREFS0_MASK | MCG_C2_IRCS_MASK;
    
38.    
    
39.     /* MCG_C5: ??=0,PLLCLKEN=0,PLLSTEN=1,PRDIV=0x03 */
    
40.     MCG_C5 = (uint8_t)0x23U;
    
41.    
    
42.     /* MCG_C6: LOLIE=0,PLLS=1,CME=0,VDIV=0x18 */
    
43.     MCG_C6 = (uint8_t)0x58U;
    
44.     while((MCG_S & 0x0CU) != 0x08U) {    /* Wait until external reference clock is selected as MCG output */
    
45.     }
    
46.     while((MCG_S & MCG_S_LOCK0_MASK) == 0x00U) { /* Wait until locked */
    
47.     }
    
48.     /* Switch to PEE Mode */
    
49.     /* MCG_C1: CLKS=0,FRDIV=3,IREFS=0,IRCLKEN=0,IREFSTEN=0 */
    
50.     MCG_C1 = (uint8_t)0x18U;
    
51.    
    
52.     /* MCG_C2: ??=0,??=0,RANGE=2,HGO=0,EREFS=0,LP=0,IRCS=1 */
    
53.     MCG_C2 = MCG_C2_RANGE0(2) | MCG_C2_EREFS0_MASK | MCG_C2_IRCS_MASK;
    
54. 
    
55.     /* MCG_C5: ??=0,PLLCLKEN=0,PLLSTEN=1,PRDIV=0x03 */
    
56.     MCG_C5 = (uint8_t)0x23U;
    
57.     /* MCG_C6: LOLIE=0,PLLS=1,CME=0,VDIV=0x18 */
    
58.     MCG_C6 = (uint8_t)0x58U;
    
59.     while((MCG_S & 0x0CU) != 0x0CU) {    /* Wait until output of the PLL is selected */
    
60.     }
    
61.     /* MCG_C6: CME=1 */
    
62.     MCG_C6 |= (uint8_t)0x20U;            /* Enable the clock monitor */
    
63.     /*** End of PE initialization code after reset ***/
    
64.     return 0;
    
65. /* end MCU_MKL25Z4 */
    
66. }
    

复制代码

     USB_Init()

1. static void USB_Init(uint_8 controller_ID)
   
2. {
   
3.         if(controller_ID == MAX3353)
   
4.         {
   
5. #ifdef MCU_MK70F12
   
6.                 /* MPU is disabled. All accesses from all bus masters are allowed */
   
7.                 MPU_CESR=0;
   
8. 
   
9.                 SIM_SOPT2 |= SIM_SOPT2_PLLFLLSEL(1)         /** PLL0 reference */
   
10.                                    | SIM_SOPT2_USBFSRC(0)                        /** MCGPLLCLK as CLKC source */
    
11.                                   | SIM_SOPT2_USBF_CLKSEL_MASK;        /** USB fractional divider like USB reference clock */
    
12.                 SIM_CLKDIV2 = USB_FRAC | USB_DIV;                /** Divide reference clock to obtain 48MHz */
    
13. 
    
14.                 /* Enable USB-OTG IP clocking */
    
15.                 SIM_SCGC4 |= SIM_SCGC4_USBFS_MASK;
    
16. #else
    
17.     #ifndef MCU_MKL25Z4
    
18.                 SIM_CLKDIV2 &= (uint32_t)(~(SIM_CLKDIV2_USBFRAC_MASK | SIM_CLKDIV2_USBDIV_MASK));
    
19.     #endif /* MCU_MKL25Z4 */
    
20.     #ifdef MCGOUTCLK_72_MHZ
    
21.                 /* Configure USBFRAC = 0, USBDIV = 0 => frq(USBout) = 2 / 3 * frq(PLLin) */
    
22.                 SIM_CLKDIV2 = SIM_CLKDIV2_USBDIV(2) | SIM_CLKDIV2_USBFRAC_MASK;
    
23.     #else
    
24.         #ifndef MCU_MKL25Z4
    
25.                 /* Configure USBFRAC = 0, USBDIV = 0 => frq(USBout) = 1 / 1 * frq(PLLin) */
    
26.                 SIM_CLKDIV2 = SIM_CLKDIV2_USBDIV(0);
    
27.         #endif /* MCU_MKL25Z4 */
    
28.     #endif /* MCGOUTCLK_72_MHZ */
    
29. 
    
30.                 /* 1. Configure USB to be clocked from PLL */
    
31.                 SIM_SOPT2 |= SIM_SOPT2_USBSRC_MASK | SIM_SOPT2_PLLFLLSEL_MASK;
    
32. 
    
33. #if PLL_96
    
34.                 /* 2. USB freq divider */
    
35.                 SIM_CLKDIV2 = 0x02;
    
36. #endif /* PLL_96 */
    
37. 
    
38.                 /* 3. Enable USB-OTG IP clocking */
    
39.                 SIM_SCGC4 |= (SIM_SCGC4_USBOTG_MASK);      
    
40. 
    
41.                 /* old documentation writes setting this bit is mandatory */
    
42.                 USB0_USBTRC0 = 0x40;
    
43.                
    
44.                 /* Configure enable USB regulator for device */
    
45. #if(defined MCU_MK20D5)               
    
46.                 SIM_SOPT1CFG |= SIM_SOPT1CFG_URWE_MASK; /* Enable SOPT1 to be written */
    
47. #endif               
    
48.                 SIM_SOPT1 |= SIM_SOPT1_USBREGEN_MASK;
    
49. }
    
50. #endif
    

复制代码

    GPIO_Init()

1. static void GPIO_Init()
   
2. {   
   
3. #if defined(MCU_MKL25Z4)  
   
4.     /* Enable clock gating to PORTA, PORTB, PORTC, PORTD and PORTE */
   
5.     SIM_SCGC5 |= (SIM_SCGC5_PORTA_MASK
   
6.               | SIM_SCGC5_PORTB_MASK
   
7.               | SIM_SCGC5_PORTC_MASK
   
8.               | SIM_SCGC5_PORTD_MASK
   
9.               | SIM_SCGC5_PORTE_MASK);
   
10. 
    
11.     /* LEDs settings */
    
12.     PORTA_PCR5  =  PORT_PCR_MUX(1);
    
13.     PORTA_PCR16 =  PORT_PCR_MUX(1);
    
14.     PORTA_PCR17 =  PORT_PCR_MUX(1);
    
15.     PORTB_PCR8  =  PORT_PCR_MUX(1);
    
16. 
    
17.     GPIOA_PDDR |= (1<<5) | (1<<16) | (1<<17);
    
18.     GPIOB_PDDR |= (1<<8);
    
19. 
    
20.     /* Switch buttons settings */
    
21.     /* Set input on PORTC pin 3 */
    
22. #ifndef _USB_BATT_CHG_APP_H_
    
23.     PORTC_PCR3 =  PORT_PCR_MUX(1);
    
24.     GPIOC_PDDR &= ~((uint_32)1 << 3);
    
25.     /* Pull up enabled */
    
26.     PORTC_PCR3 |= PORT_PCR_PE_MASK | PORT_PCR_PS_MASK;
    
27.     /* GPIO_INT_EDGE_HIGH */
    
28.     PORTC_PCR3 |= PORT_PCR_IRQC(9);
    
29. 
    
30.     /* Set input on PORTA pin 4 */
    
31.     PORTA_PCR4 =  PORT_PCR_MUX(1);
    
32.     GPIOA_PDDR &= ~((uint_32)1 << 4);
    
33.     /* Pull up */
    
34.     PORTA_PCR4 |= PORT_PCR_PE_MASK | PORT_PCR_PS_MASK;
    
35.     /* GPIO_INT_EDGE_HIGH */
    
36.     PORTA_PCR4 |= PORT_PCR_IRQC(9);
    
37. 
    
38.     /* Clear interrupt flag */
    
39.     PORTC_ISFR = (1 << 3);
    
40.     PORTA_ISFR = (1 << 4);
    
41. 
    
42.     /* Enable interrupt port A */
    
43.     NVIC_ICPR = 1 << 30;
    
44.     NVIC_ISER = 1 << 30;
    
45. #endif
    
46. #endif
    
47. }
    

复制代码

文档下载：
参考文献：
[1] Freescale USB Device Stack Users Guide
[2]  Freescale USB Stack Device API Reference Manual
[3] FSL USB Stack 4.1.1

FSL_TICS_ZP

如有什么错误或者不足，欢迎网友指正，请在后面跟帖！

fengyunyu

BSP的相关配置代码是PE生产的么？用惯了st的库，看起来眼晕。

weiwei4

嗯，不错，不过在USB 描述符 这个方面没有 详细的分析，描述符能不能看懂，会不会改是做HID设备时很重要的一环啊
最近都在做USB有关的程序，很希望哪位能详细分析下HID相关的描述符，这样就不用看文档看得那么辛苦

ndust

我现在感觉少量数据通讯HID还真是方便。以前开发编程器的时候，就考虑过，后来已经开发了一半了，也就没有推倒重来。HID不需要驱动，对少量数据交换还是很方便的。现在的很多读卡器都是采用这样的模式了。很方便。

riyue

非常好，顶

ccrt

能把程序完整的给出来么？看的有点不知所措

CharlesLu

学习一下

lzgq

下载下来参考下

FSL_TICS_ZP

fengyunyu 发表于 2014-9-15 11:55
BSP的相关配置代码是PE生产的么？用惯了st的库，看起来眼晕。

这个例程不是基于PE的，我会将USB stack 4.1.1的链接在帖子中给出，你可以自己看一下。

ltmooner

帮顶~~~~不错~~

FSL_TICS_ZP

weiwei4 发表于 2014-9-15 17:14
嗯，不错，不过在USB 描述符 这个方面没有 详细的分析，描述符能不能看懂，会不会改是做HID设备时很重要的 ...

在这一次不会讲相关描述符的内容，但在之前我们已经针对USB的基础知识作了两篇文章，进行详细的介绍啊，
相信对你应该很有帮助，链接如下。
http://www.amobbs.com/thread-5575630-1-1.html
http://www.amobbs.com/thread-5578354-1-1.html

FSL_TICS_ZP

ccrt 发表于 2014-9-15 21:50
能把程序完整的给出来么？看的有点不知所措

文章没有写完，所以例程没有完全给出，
但你你可以根据我在帖子中，给出的USB stack 4.1.1下载链接，下载后，打开工程看看代码。

FSL_TICS_ZP

ltmooner 发表于 2014-9-16 09:01
帮顶~~~~不错~~

谢谢支持！

xinbadazz

谢谢，努力学习。。。

haoyurenzhu

mark 。。。。。

yzb1019

看着好像有点库文件的意思,飞思卡尔的这款芯片是不是也有封装库了？

FSL_TICS_ZP

yzb1019 发表于 2014-9-16 09:27
看着好像有点库文件的意思,飞思卡尔的这款芯片是不是也有封装库了？

这不是库文件。

yzb1019

FSL_TICS_ZP 发表于 2014-9-16 10:05
这不是库文件。

那应该是USB库文件？

weiwei4

FSL_TICS_ZP 发表于 2014-9-16 09:02
在这一次不会讲相关描述符的内容，但在之前我们已经针对USB的基础知识作了两篇文章，进行详细的介绍啊，
...

原来在官方例程里有对USB这么详细分析的文档，官方例程没看完，所以不知道后面有这么好的内容，谢谢版主了

qq11qqviki

下载下来参考下