From c86491af8b24679984a3fc5effc7675779652e4c Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Tue, 11 Aug 2009 09:12:29 +0000 Subject: [PATCH] Add new functions to the HID host class driver, refine HID interface protocol matching. Remove stray state variable from the CDC host class driver. --- Demos/Host/ClassDriver/CDCHost/CDCHost.h | 3 +- Demos/Host/ClassDriver/MouseHost/MouseHost.c | 1 - Demos/Host/ClassDriver/MouseHost/MouseHost.h | 2 +- Demos/Host/ClassDriver/makefile | 25 +++++++++++++++ LUFA.pnproj | 2 +- LUFA/Drivers/USB/Class/Host/CDC.c | 4 +-- LUFA/Drivers/USB/Class/Host/CDC.h | 8 ++--- LUFA/Drivers/USB/Class/Host/HID.c | 33 ++++++++++++++++++-- LUFA/Drivers/USB/Class/Host/HID.h | 24 ++++++++------ 9 files changed, 80 insertions(+), 22 deletions(-) create mode 100644 Demos/Host/ClassDriver/makefile diff --git a/Demos/Host/ClassDriver/CDCHost/CDCHost.h b/Demos/Host/ClassDriver/CDCHost/CDCHost.h index ab31a57930..d666b73d64 100644 --- a/Demos/Host/ClassDriver/CDCHost/CDCHost.h +++ b/Demos/Host/ClassDriver/CDCHost/CDCHost.h @@ -47,7 +47,8 @@ #include #include #include - #include \ + #include + #include /* Macros: */ /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */ diff --git a/Demos/Host/ClassDriver/MouseHost/MouseHost.c b/Demos/Host/ClassDriver/MouseHost/MouseHost.c index cf2997bcd2..9f76bc754b 100644 --- a/Demos/Host/ClassDriver/MouseHost/MouseHost.c +++ b/Demos/Host/ClassDriver/MouseHost/MouseHost.c @@ -47,7 +47,6 @@ USB_ClassInfo_HID_Host_t Mouse_HID_Interface = .DataINPipeNumber = 1, .DataOUTPipeNumber = 2, - .MatchInterfaceProtocol = true, .HIDInterfaceProtocol = 0x02, }, }; diff --git a/Demos/Host/ClassDriver/MouseHost/MouseHost.h b/Demos/Host/ClassDriver/MouseHost/MouseHost.h index 9f92be0865..c6b2974bd9 100644 --- a/Demos/Host/ClassDriver/MouseHost/MouseHost.h +++ b/Demos/Host/ClassDriver/MouseHost/MouseHost.h @@ -48,7 +48,7 @@ #include #include #include - #include + #include /* Macros: */ /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */ diff --git a/Demos/Host/ClassDriver/makefile b/Demos/Host/ClassDriver/makefile new file mode 100644 index 0000000000..993fe8b596 --- /dev/null +++ b/Demos/Host/ClassDriver/makefile @@ -0,0 +1,25 @@ +# +# LUFA Library +# Copyright (C) Dean Camera, 2009. +# +# dean [at] fourwalledcubicle [dot] com +# www.fourwalledcubicle.com +# + +# Makefile to build all the LUFA Host Demos. Call with "make all" to +# rebuild all Host demos. + +# Projects are pre-cleaned before each one is built, to ensure any +# custom LUFA library build options are reflected in the compiled +# code. + +all: + make -C CDCHost clean + make -C CDCHost all + + make -C MouseHost clean + make -C MouseHost all + +%: + make -C CDCHost $@ + make -C MouseHost $@ diff --git a/LUFA.pnproj b/LUFA.pnproj index d73823e0a9..13c14eca47 100644 --- a/LUFA.pnproj +++ b/LUFA.pnproj @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/LUFA/Drivers/USB/Class/Host/CDC.c b/LUFA/Drivers/USB/Class/Host/CDC.c index 2985b248e8..e790e64f87 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.c +++ b/LUFA/Drivers/USB/Class/Host/CDC.c @@ -52,9 +52,9 @@ uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint CDCInterfaceInfo->State.ControlInterfaceNumber = #if defined(USE_NONSTANDARD_DESCRIPTOR_NAMES) - DESCRIPTOR_CAST(ConfigDescriptorData, USB_Descriptor_Interface_t).InterfaceNumber; + DESCRIPTOR_CAST(ConfigDescriptorData, USB_Descriptor_Interface_t).InterfaceNumber; #else - DESCRIPTOR_CAST(ConfigDescriptorData, USB_Descriptor_Interface_t).bInterfaceNumber; + DESCRIPTOR_CAST(ConfigDescriptorData, USB_Descriptor_Interface_t).bInterfaceNumber; #endif while (FoundEndpoints != (CDC_FOUND_DATAPIPE_IN | CDC_FOUND_DATAPIPE_OUT | CDC_FOUND_DATAPIPE_NOTIFICATION)) diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h index 79df489ff9..b7c492af84 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.h +++ b/LUFA/Drivers/USB/Class/Host/CDC.h @@ -71,8 +71,10 @@ */ struct { - bool Active; /**< Indicates if the current interface instance is connected to an attached device */ - + bool Active; /**< Indicates if the current interface instance is connected to an attached device, valid + * after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the + * Configured state + */ uint8_t ControlInterfaceNumber; /**< Interface index of the CDC-ACM control interface within the attached device */ uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */ @@ -91,8 +93,6 @@ struct { - bool Active; /**< Indicates if the interface is currently active, i.e. attached to the connected device */ - uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */ uint8_t CharFormat; /**< Character format of the virtual serial port, a value from the * CDCDevice_CDC_LineCodingFormats_t enum diff --git a/LUFA/Drivers/USB/Class/Host/HID.c b/LUFA/Drivers/USB/Class/Host/HID.c index a42f8afa34..dc69977363 100644 --- a/LUFA/Drivers/USB/Class/Host/HID.c +++ b/LUFA/Drivers/USB/Class/Host/HID.c @@ -46,6 +46,8 @@ uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration) return HID_ENUMERROR_InvalidConfigDescriptor; + USB_Descriptor_Interface_t* CurrentHIDInterface; + do { if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, @@ -53,9 +55,18 @@ uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint { return HID_ENUMERROR_NoHIDInterfaceFound; } - } while (HIDInterfaceInfo->Config.MatchInterfaceProtocol && - DESCRIPTOR_PCAST(ConfigDescriptorData, - USB_Descriptor_Interface_t)->Protocol != HIDInterfaceInfo->Config.HIDInterfaceProtocol); + + CurrentHIDInterface = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Interface_t); + } while (HIDInterfaceInfo->Config.HIDInterfaceProtocol && + (CurrentHIDInterface->Protocol != HIDInterfaceInfo->Config.HIDInterfaceProtocol)); + + HIDInterfaceInfo->State.InterfaceNumber = + #if defined(USE_NONSTANDARD_DESCRIPTOR_NAMES) + CurrentHIDInterface->InterfaceNumber; + #else + CurrentHIDInterface->bInterfaceNumber; + #endif + HIDInterfaceInfo->State.SupportsBootSubClass = (CurrentHIDInterface->SubClass != 0); while (FoundEndpoints != ((1 << HID_FOUND_DATAPIPE_IN) | (1 << HID_FOUND_DATAPIPE_OUT))) { @@ -144,4 +155,20 @@ bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) return ReportReceived; } +uint8_t USB_HID_Host_SetProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, bool UseReportProtocol) +{ + USB_ControlRequest = (USB_Request_Header_t) + { + .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE), + .bRequest = REQ_SetProtocol, + .wValue = UseReportProtocol, + .wIndex = HIDInterfaceInfo->State.InterfaceNumber, + .wLength = 0, + }; + + Pipe_SelectPipe(PIPE_CONTROLPIPE); + + return USB_Host_SendControlRequest(NULL); +} + #endif diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h index e67103a693..d94fa2e0e4 100644 --- a/LUFA/Drivers/USB/Class/Host/HID.h +++ b/LUFA/Drivers/USB/Class/Host/HID.h @@ -66,23 +66,28 @@ { uint8_t DataINPipeNumber; /**< Pipe number of the HID interface's IN data pipe */ uint8_t DataOUTPipeNumber; /**< Pipe number of the HID interface's OUT data pipe */ - - bool MatchInterfaceProtocol; /**< Indicates whether the driver should match the device's - * HID interface protocol's value to the \ref HIDInterfaceProtocol - * suppled (otherwise just accept all HID class devices) - */ - uint8_t HIDInterfaceProtocol; /**< HID interface protocol value to match against if the - * \ref MatchInterfaceProtocol is set to true (ignored otherwise) + + uint8_t HIDInterfaceProtocol; /**< HID interface protocol value to match against if a specific + * boot subclass protocol is required (e.g. keyboard, mouse), or + * leave as 0 to match against the first HID interface found */ } Config; /**< Config data for the USB class interface within the device. All elements in this section * must be set or the interface will fail to enumerate and operate correctly. */ struct { - bool Active; /**< Indicates if the current interface instance is connected to an attached device */ + bool Active; /**< Indicates if the current interface instance is connected to an attached device, valid + * after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the + * Configured state + */ + uint8_t InterfaceNumber; /**< Interface index of the HID interface within the attached device */ uint16_t DataINPipeSize; /**< Size in bytes of the HID interface's IN data pipe */ uint16_t DataOUTPipeSize; /**< Size in bytes of the HID interface's OUT data pipe */ + + bool SupportsBootSubClass; /**< Indicates if the current interface instance supports the HID Boot + * Protocol when enabled via \ref USB_HID_Host_SetProtocol() + */ } State; /**< State data for the USB class interface within the device. All elements in this section * may be set to initial values, but may also be ignored to default to sane values when * the interface is enumerated. @@ -103,7 +108,8 @@ uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint16_t ConfigDescriptorLength, uint8_t* DeviceConfigDescriptor); - bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo); + bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo); + uint8_t USB_HID_Host_SetProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, bool UseReportProtocol); /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__)