[USB HID] Clean HID composite interface

fpistm · fpistm · commit 8f20f02afd0f · 2019-01-25T17:31:41.000+01:00
Signed-off-by: Frederic.Pillon &lt;frederic.pillon@st.com&gt;
diff --git a/cores/arduino/board.h b/cores/arduino/board.h
@@ -20,7 +20,6 @@ extern "C"{
 #include "timer.h"
 #include "twi.h"
 #include "uart.h"
-#include "usbd_interface.h"
 
 void init( void ) ;
 #ifdef __cplusplus
diff --git a/cores/arduino/main.cpp b/cores/arduino/main.cpp
@@ -54,10 +54,6 @@ int main( void )
 {
   initVariant();
 
-#if defined(USBCON)
-  usbd_interface_init();
-#endif
-
   setup();
 
   for (;;)
diff --git a/cores/arduino/stm32/usb/hid/usbd_hid_composite_if.c b/cores/arduino/stm32/usb/hid/usbd_hid_composite_if.c
@@ -1,7 +1,7 @@
 /**
   ******************************************************************************
-  * @file    usbd_interface.c
-  * @brief   Provide the USB device interface
+  * @file    usbd_hid_composite_if.c
+  * @brief   Provide the USB HID composite interface
   *
   ******************************************************************************
   * @attention
@@ -33,33 +33,26 @@
   ******************************************************************************
   */
 #ifdef USBCON
-#include "usbd_desc.h"
-#include "usbd_interface.h"
 #ifdef USBD_USE_HID_COMPOSITE
+
+#include "usbd_desc.h"
+#include "usbd_hid_composite_if.h"
 #include "usbd_hid_composite.h"
-#endif
-#ifdef USBD_USE_CDC
-#include "usbd_cdc_if.h"
-#endif
 
 #ifdef __cplusplus
  extern "C" {
 #endif
 
-/* USB Device Core handle declaration */
-#ifdef USBD_USE_HID_COMPOSITE
+/* USB Device Core HID composite handle declaration */
 USBD_HandleTypeDef hUSBD_Device_HID;
-#endif /* USBD_USE_HID_COMPOSITE*/
 
 /**
-  * @brief  initialize USB devices
+  * @brief  Initialize USB devices
   * @param  none
   * @retval none
   */
-__attribute__((weak))
-void usbd_interface_init(void)
+void HID_Composite_Init(void)
 {
-#ifdef USBD_USE_HID_COMPOSITE
   /* Init Device Library */
   USBD_Init(&hUSBD_Device_HID, &HID_Desc, 0);
 
@@ -68,17 +61,29 @@ void usbd_interface_init(void)
 
   /* Start Device Process */
   USBD_Start(&hUSBD_Device_HID);
-#endif /* USBD_USE_HID_COMPOSITE */
 }
 
-#ifdef USBD_USE_HID_COMPOSITE
+/**
+  * @brief  DeInitialize USB devices
+  * @param  none
+  * @retval none
+  */
+void HID_Composite_DeInit(void)
+{
+  /* Stop Device Process */
+  USBD_Stop(&hUSBD_Device_HID);
+
+  /* DeInit Device Library */
+  USBD_DeInit(&hUSBD_Device_HID);
+}
+
 /**
   * @brief  Send HID mouse Report
   * @param  report pointer to report
   * @param  len report lenght
   * @retval none
   */
-void usbd_interface_mouse_sendReport(uint8_t *report, uint16_t len)
+void HID_Composite_mouse_sendReport(uint8_t *report, uint16_t len)
 {
   USBD_HID_MOUSE_SendReport(&hUSBD_Device_HID, report, len);
 }
@@ -89,14 +94,14 @@ void usbd_interface_mouse_sendReport(uint8_t *report, uint16_t len)
   * @param  len report lenght
   * @retval none
   */
-void usbd_interface_keyboard_sendReport(uint8_t *report, uint16_t len)
+void HID_Composite_keyboard_sendReport(uint8_t *report, uint16_t len)
 {
   USBD_HID_KEYBOARD_SendReport(&hUSBD_Device_HID, report, len);
 }
-#endif /* USBD_USE_HID_COMPOSITE */
 
 #ifdef __cplusplus
 }
 #endif
+#endif /* USBD_USE_HID_COMPOSITE */
 #endif /* USBCON */
 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
diff --git a/cores/arduino/stm32/usb/hid/usbd_hid_composite_if.h b/cores/arduino/stm32/usb/hid/usbd_hid_composite_if.h
@@ -1,7 +1,7 @@
 /**
   ******************************************************************************
-  * @file    usbd_interface.h
-  * @brief   Header for USB device interface
+  * @file    usbd_hid_composite_if.h
+  * @brief   Header for USB HID composite interface
   ******************************************************************************
   * @attention
   *
@@ -33,32 +33,29 @@
   */
 
 /* Define to prevent recursive inclusion -------------------------------------*/
-#ifndef __USBD_INTERFACE_H
-#define __USBD_INTERFACE_H
+#ifndef __USBD_HID_COMPOSITE_IF_H
+#define __USBD_HID_COMPOSITE_IF_H
 #ifdef USBCON
+#ifdef USBD_USE_HID_COMPOSITE
 
 /* Includes ------------------------------------------------------------------*/
 #ifdef __cplusplus
  extern "C" {
 #endif
 
-/* Exported types ------------------------------------------------------------*/
-/* Exported constants --------------------------------------------------------*/
-/* Exported macro ------------------------------------------------------------*/
-/* Exported variables --------------------------------------------------------*/
 /* Exported functions ------------------------------------------------------- */
-void usbd_interface_init(void);
+void HID_Composite_Init(void);
+void HID_Composite_DeInit(void);
 
-#ifdef USBD_USE_HID_COMPOSITE
-void usbd_interface_mouse_sendReport(uint8_t *report, uint16_t len);
-void usbd_interface_keyboard_sendReport(uint8_t *report, uint16_t len);
-#endif
+void HID_Composite_mouse_sendReport(uint8_t *report, uint16_t len);
+void HID_Composite_keyboard_sendReport(uint8_t *report, uint16_t len);
 
 #ifdef __cplusplus
 }
 #endif
+#endif /* USBD_USE_HID_COMPOSITE */
 #endif /* USBCON */
 
-#endif /* __USBD_INTERFACE_H */
+#endif /* __USBD_HID_COMPOSITE_IF_H */
 
 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
diff --git a/libraries/Keyboard/library.properties b/libraries/Keyboard/library.properties
@@ -1,5 +1,5 @@
 name=Keyboard
-version=1.0.1
+version=1.1.0
 author=Arduino
 maintainer=Arduino <info@arduino.cc>
 sentence=Allows an Arduino/Genuino board with USB capabilites to act as a Keyboard.
diff --git a/libraries/Keyboard/src/Keyboard.cpp b/libraries/Keyboard/src/Keyboard.cpp
@@ -22,6 +22,7 @@
 #include "Keyboard.h"
 
 #if defined(USBCON)
+#include "usbd_hid_composite_if.h"
 
 //================================================================================
 //================================================================================
@@ -33,18 +34,20 @@ Keyboard_::Keyboard_(void)
 
 void Keyboard_::begin(void)
 {
+  HID_Composite_Init();
 }
 
 void Keyboard_::end(void)
 {
+  HID_Composite_DeInit();
 }
 
 void Keyboard_::sendReport(KeyReport* keys)
 {
   uint8_t buf[8] = {keys->modifiers, keys->reserved, keys->keys[0], keys->keys[1],
                     keys->keys[2], keys->keys[3], keys->keys[4], keys->keys[5]};
 
-  usbd_interface_keyboard_sendReport(buf, 8);
+  HID_Composite_keyboard_sendReport(buf, 8);
 
   //delay required to prevent persistent key when call print
   delay(20);
diff --git a/libraries/Mouse/library.properties b/libraries/Mouse/library.properties
@@ -1,5 +1,5 @@
 name=Mouse
-version=1.0.0
+version=1.1.0
 author=Arduino
 maintainer=Arduino <info@arduino.cc>
 sentence=Allows an Arduino board with USB capabilites to act as a Mouse. For Leonardo/Micro only
diff --git a/libraries/Mouse/src/Mouse.cpp b/libraries/Mouse/src/Mouse.cpp
@@ -22,6 +22,7 @@
 #include "Mouse.h"
 
 #if defined(USBCON)
+#include "usbd_hid_composite_if.h"
 
 //================================================================================
 //================================================================================
@@ -33,10 +34,12 @@ Mouse_::Mouse_(void) : _buttons(0)
 
 void Mouse_::begin(void)
 {
+  HID_Composite_Init();
 }
 
 void Mouse_::end(void)
 {
+  HID_Composite_DeInit();
 }
 
 void Mouse_::click(uint8_t b)
@@ -55,7 +58,7 @@ void Mouse_::move(signed char x, signed char y, signed char wheel)
 	m[2] = y;
 	m[3] = wheel;
 
-  usbd_interface_mouse_sendReport(m, 4);
+  HID_Composite_mouse_sendReport(m, 4);
 }
 
 void Mouse_::buttons(uint8_t b)

Original file line number	Diff line number	Diff line change
`@@ -54,10 +54,6 @@ int main( void )`
`54`	`54`	`{`
`55`	`55`	`initVariant();`
`56`	`56`
`57`		`-#if defined(USBCON)`
`58`		`- usbd_interface_init();`
`59`		`-#endif`
`60`		`-`
`61`	`57`	`setup();`
`62`	`58`
`63`	`59`	`for (;;)`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@`
`22`	`22`	`#include "Keyboard.h"`
`23`	`23`
`24`	`24`	`#if defined(USBCON)`
	`25`	`+#include "usbd_hid_composite_if.h"`
`25`	`26`
`26`	`27`	`//================================================================================`
`27`	`28`	`//================================================================================`
`@@ -33,18 +34,20 @@ Keyboard_::Keyboard_(void)`
`33`	`34`
`34`	`35`	`void Keyboard_::begin(void)`
`35`	`36`	`{`
	`37`	`+ HID_Composite_Init();`
`36`	`38`	`}`
`37`	`39`
`38`	`40`	`void Keyboard_::end(void)`
`39`	`41`	`{`
	`42`	`+ HID_Composite_DeInit();`
`40`	`43`	`}`
`41`	`44`
`42`	`45`	`void Keyboard_::sendReport(KeyReport* keys)`
`43`	`46`	`{`
`44`	`47`	`uint8_t buf[8] = {keys->modifiers, keys->reserved, keys->keys[0], keys->keys[1],`
`45`	`48`	`keys->keys[2], keys->keys[3], keys->keys[4], keys->keys[5]};`
`46`	`49`
`47`		`- usbd_interface_keyboard_sendReport(buf, 8);`
	`50`	`+ HID_Composite_keyboard_sendReport(buf, 8);`
`48`	`51`
`49`	`52`	`//delay required to prevent persistent key when call print`
`50`	`53`	`delay(20);`