5.1 按键实验

本节课将直接以实验的方式讲解如何使用HAL按键驱动API，本节课的实验内容是按下按键后闪烁LED。

按键API文件

HAL提供了完善按键驱动API，其定义在在hal_key.h和hal_key.c中，如下图所示。
第5章：硬件适配层应用——按键 - 图1

按键的定义与映射

（1）打开头文件hal_led.h，可以找到如下代码：
第5章：硬件适配层应用——按键 - 图2

（2）其中的SW_1到SW_5是方向按键，用得很少，故不展开讲解。SW_6和SW_7是常规按键。

（3）与LED类似，可以在头文件hal_board_cfg.h中配置按键与CC2530引脚的对接关系。以下是SW_6的默认是配置，代码如下：

  1. /* S1 按键 */
  2. #define PUSH1_BV          BV(1)
  3. #define PUSH1_SBIT        P0_1
  5. //按键按下时的电平
  6. #if defined (HAL_BOARD_CC2530EB_REV17)
  7.   #define PUSH1_POLARITY    ACTIVE_HIGH
  8. #elif defined (HAL_BOARD_CC2530EB_REV13)
  9.   #define PUSH1_POLARITY    ACTIVE_LOW
  10. #else
  11.   #error Unknown Board Indentifier
  12. #endif

（4）通常，这个按键已经能满足大多数设备需求了。配套的ZigBee开发板中的按键连接的引脚正是P0_1。然而，我们按键的电路是按下时为低电平，未按下时为高电平，所以还需要修改一下配置，修改后的配置代码如下：

  1. /* S1 按键 */
  2. #define PUSH1_BV          BV(1)
  3. #define PUSH1_SBIT        P0_1
  5. //表示低电平时驱动按键
  6. #define PUSH1_POLARITY    ACTIVE_LOW

提示：
在前面的章节中已经讲解过按键的电路，有需要的读者可以翻阅一下。

处理按键事件

（1）由于按键是受OSAL的调度的，所以在Z-Stack中使用按键之前，必须要现在OSAL中注册。可以在应用层中注册，应用层的初始化函数zclSampleSw_Init默认已经完成了此注册工作，如图所示：
第5章：硬件适配层应用——按键 - 图3

（2）注册后，如果按键被按下，那么就会产生一个应用层的系统事件KEY_CHANGE。打开zcl_samplesw.c文件中的zclSampleSw_event_loop函数，可以找到KEY_CHANGE事件的处理函数zclSampleSw_HandleKeys，如图所示。
第5章：硬件适配层应用——按键 - 图4

（3）事件处理函数zclSampleSw_HandleKeys的代码定义如下：
第5章：硬件适配层应用——按键 - 图5

（4）zclSampleSw_HandleKeys函数默认的工作内容是在LCD显示屏中显示按键按下的信息。开发者可在此处添加按键事件处理代码，例如前面章节讲解过的闪烁LED，参考代码如下：
第5章：硬件适配层应用——按键 - 图6

启用按键的宏定义

（1）与LED类似，在使用按键前，需要启用按键对应的宏定义HAL_KEY。在下图中的Defined sybols中输入以下代码。

  1. HAL_KEY=TRUE
  2. ISR_KEYINTERRUPT

（2）添加后，如图所示。
第5章：硬件适配层应用——按键 - 图7

（3）定义宏ISR_KEYINTERRUPT是因为系统是使用中断的方式检测按键行为的，读者暂时大概了解一下即可。

调试仿真

编译工程后把程序烧录到开发板中并且运行后，当按键被按下时可以看到LED闪烁。

5.2 HAL 按键框架详解（选修）

概述

上节课讲解HAL 按键的API的使用，本节课将深入分析一下其中原理。如果读者暂时不需要学习其中的原理，可以跳过本节课。

hal_key.c文件

HAL的按键框架的主要代码在hal_key.c文件中，打开该文件可以找到以下这几个重要的函数：

  1. HalKeyInit
  2. HalKeyConfig
  3. HalKeyPoll
  4. HAL_ISR_FUNCTION( halKeyPort0Isr, P0INT_VECTOR )

初始化函数HalKeyInit

初始化函数HalKeyInit的代码如下：

  1. 1.void HalKeyInit( void )    
  2. 2.{    
  3. 3.  /* Initialize previous key to 0 */    
  4. 4.  halKeySavedKeys = 0;    
  5. 5.    
  6. 6.  HAL_KEY_SW_6_SEL &= ~(HAL_KEY_SW_6_BIT);  // I/O为普通GPIO  
  7. 7.    
  8. 8.#if ! defined ENABLE_LED4_DISABLE_S1    
  9. 9.  HAL_KEY_SW_6_DIR &= ~(HAL_KEY_SW_6_BIT);  // I/O配置为输入  
  10. 10.#endif    
  11. 11.      
  12. 12.  HAL_KEY_JOY_MOVE_SEL &= ~(HAL_KEY_JOY_MOVE_BIT);  
  13. 13.  HAL_KEY_JOY_MOVE_DIR &= ~(HAL_KEY_JOY_MOVE_BIT);   
  14. 14.    
  15. 15.  /* Initialize callback function */    
  16. 16.  pHalKeyProcessFunction  = NULL;    
  17. 17.    
  18. 18.  /* Start with key is not configured */    
  19. 19.  HalKeyConfigured = FALSE;    
  20. 20.}

初始化函数主要工作内容是把GPIO配置为输入功能。HAL_KEY_SW_6_SEL等定义其实是按键GPIO配置相关的寄存器，这些定义可以在hal_key.c中找到，如果我们需要添加其他按键，也遵循这个方法即可。
配置HAL_KEY_6相关寄存器的定义如下：
第5章：硬件适配层应用——按键 - 图8

在初始化函数HalKeyInit中有个地方需要说明，这个函数中有一段代码（用了快配置HAL_KEY_SW_6这个按键的引脚为输入功能）：

  1. 1.#if ! defined ENABLE_LED4_DISABLE_S1    
  2. 2.  HAL_KEY_SW_6_DIR &= ~(HAL_KEY_SW_6_BIT);  // I/O配置为输入  
  3. 3.#endif

ZStack的本意是S1按键引脚P0_1可以用来驱动LED，就是和按键复用了，是否用作LED取决于宏ENABLE_LED4_DISABLE_S1是否定义，但是协议栈没有开源的那部分代码中定义了这个宏，也算是ZStack的一个Bug，所以这段代码我们需做修改，把预编译去掉（注释掉），否则按键引脚不会被配置为输入：

  1. 1.// #if ! defined ENABLE_LED4_DISABLE_S1    
  2. 2.  HAL_KEY_SW_6_DIR &= ~(HAL_KEY_SW_6_BIT);  // I/O配置为输入  
  3. 3.// #endif

HalKeyConfig

这个函数主要用来配置和中断相关的内容:

  1. 1.void HalKeyConfig (bool interruptEnable, halKeyCBack_t cback)
  2. 2.{  
  3. 3.  Hal_KeyIntEnable = interruptEnable;  // 标志：是否使能中断
  4. 4.  
  5. 5.  pHalKeyProcessFunction = cback;  // 回调函数，按键按下时调用
  6. 6.  
  7. 7.  /* Determine if interrupt is enable or not */  
  8. 8.  if (Hal_KeyIntEnable)  // 如果使能了中断，必须配置中断相关内容
  9. 9.  {  
  10. 10.    PICTL &= ~(HAL_KEY_SW_6_EDGEBIT); /* Clear the edge bit */  
  11. 11.    /* For falling edge, the bit must be set. */  
  12. 12.  #if (HAL_KEY_SW_6_EDGE == HAL_KEY_FALLING_EDGE)  
  13. 13.    PICTL |= HAL_KEY_SW_6_EDGEBIT;  
  14. 14.  #endif  
  15. 15.
  16. 16.    /* Interrupt configuration: 
  17. 17.     * - Enable interrupt generation at the port 
  18. 18.     * - Enable CPU interrupt 
  19. 19.     * - Clear any pending interrupt 
  20. 20.     */  
  21. 21.    HAL_KEY_SW_6_ICTL |= HAL_KEY_SW_6_ICTLBIT;  
  22. 22.    HAL_KEY_SW_6_IEN |= HAL_KEY_SW_6_IENBIT;  
  23. 23.    HAL_KEY_SW_6_PXIFG = ~(HAL_KEY_SW_6_BIT);  
  24. 24.
  25. 25.    .........  // 屏蔽无关紧要的代码
  26. 26.
  27. 27.    if (HalKeyConfigured == TRUE)  
  28. 28.    {  
  29. 29.    osal_stop_timerEx(Hal_TaskID, HAL_KEY_EVENT); // 不需要轮询
  30. 30.    }  
  31. 31.  }  
  32. 32.  else   // 如果没有使用中断，必须把中断相关内容关闭掉
  33. 33.  {  
  34. 34.    HAL_KEY_SW_6_ICTL &= ~(HAL_KEY_SW_6_ICTLBIT); 
  35. 35.    HAL_KEY_SW_6_IEN &= ~(HAL_KEY_SW_6_IENBIT); 
  36. 36.    osal_set_event(Hal_TaskID, HAL_KEY_EVENT);  // 按键轮询事件
  37. 37.  }  
  38. 38.
  39. 39.  HalKeyConfigured = TRUE;  
  40. 40.}

HalKeyPoll

  1. 1.void HalKeyPoll (void)    
  2. 2.{    
  3. 3.  uint8 keys = 0;    
  4. 4.  if ((HAL_KEY_JOY_MOVE_PORT & HAL_KEY_JOY_MOVE_BIT))   
  5. 5.  {    
  6. 6.    keys = halGetJoyKeyInput();    
  7. 7.  }    
  8. 8.  /*  
  9. 9.   *   ......... 
  10. 10.   */    
  11. 11.  if (!Hal_KeyIntEnable)    
  12. 12.  {    
  13. 13.    if (keys == halKeySavedKeys)    
  14. 14.    {    
  15. 15.      return;    
  16. 16.    }    
  17. 17.    halKeySavedKeys = keys;    
  18. 18.  }    
  19. 19.  else    
  20. 20.  {    
  21. 21.    /* Key interrupt handled here */    
  22. 22.  }    
  23. 23.  if (HAL_PUSH_BUTTON1())  // 检测HAL_KEY_SW_6是否按下，添加其他
  24. 24.  {                        // 按键时，同样也需要在这里做检测！  
  25. 25.    keys |= HAL_KEY_SW_6;    
  26. 26.  }    
  27. 27.      
  28. 28.  if (pHalKeyProcessFunction    
  29. 29.#ifdef HAL_LEGACY_KEYS    
  30. 30.    && keys  
  31. 31.#endif    
  32. 32.    )    
  33. 33.  {    
  34. 34.    (pHalKeyProcessFunction) (keys, HAL_KEY_STATE_NORMAL);    
  35. 35.  }    
  36. 36.}

这个函数是用来查询按键是否按键，如果是中断方式，检测到中断时去抖然后进入这个函数；如果不是中断方式那么采用周期性轮询查看按键是否按下。

函数HAL_ISR_FUNCTION( halKeyPort0Isr, P0INT_VECTOR )：
这是个中断处理函数，中断向量是P0INT_VECTOR也就是P0口的中断，按键连接的是P0_1，按下产生中断就会来到这个函数：

  1. 1.HAL_ISR_FUNCTION( halKeyPort0Isr, P0INT_VECTOR )    
  2. 2.{    
  3. 3.  HAL_ENTER_ISR();   
  4. 4.  if (HAL_KEY_SW_6_PXIFG & HAL_KEY_SW_6_BIT)  // P0_1中断  
  5. 5.  {    
  6. 6.    halProcessKeyInterrupt();  // 调用这个函数来处理中断  
  7. 7.                                  // 最终会调用 HalKeyPoll  
  8. 8.  }    
  9. 9.  /*  
  10. 10.    Clear the CPU interrupt flag for Port_0  
  11. 11.    PxIFG has to be cleared before PxIF  
  12. 12.  */    
  13. 13.  HAL_KEY_SW_6_PXIFG = 0;      // 清除中断标志  
  14. 14.  HAL_KEY_CPU_PORT_0_IF = 0;    
  15. 15.  CLEAR_SLEEP_MODE();    
  16. 16.  HAL_EXIT_ISR();    
  17. 17.}

最终中断会在函数halProcessKeyInterrupt()中被处理：

  1. 1.void halProcessKeyInterrupt (void)  
  2. 2.{  
  3. 3.  bool valid=FALSE;  
  4. 4.  // 清除HAL_KEY_SW_6引脚对应的中断标志位
  5. 5.  if (HAL_KEY_SW_6_PXIFG & HAL_KEY_SW_6_BIT)
  6. 6.  {  
  7. 7.    HAL_KEY_SW_6_PXIFG = ~(HAL_KEY_SW_6_BIT);
  8. 8.    valid = TRUE;  
  9. 9.  }
  10. 10.  
  11. 11.  if (valid)  
  12. 12.  {    // 启动一个事件，25ms后到期（去抖），事件会在hal_drivers.c
  13. 13.        // 中被处理（Hal_ProcessEvent），最终会调用HalKeyPoll
  14. osal_start_timerEx (Hal_TaskID, HAL_KEY_EVENT, 
  15. HAL_KEY_DEBOUNCE_VALUE);  
  16. 14.  }  
  17. 15.}

问题：上面讲解的函数最终会在哪里被调用呢？

我们提供一种方法可以用来在IAR中查看所有与关键字相关的内容，进而可以找到函数被调用的地方：
第5章：硬件适配层应用——按键 - 图9

这个搜索功能是全局搜索，也就是说会IAR搜索工程中的所有文件，然后匹配我们要搜索的关键字，再将结果显示出来；比如我们想搜索与关键字HalKeyInit相关的所有内容，可以在弹出的对话框中输入这个关键字，然后点击”Find”即可，然后我们根据搜索出来的结果，可以通过鼠标双击对应的结果来查看相关内容：
第5章：硬件适配层应用——按键 - 图10