USB mouse support added, prepared for Model A(+)

Support for Model A(+) not tested yet and not activated

Author: maccasoft

uspi/Makefile

@@ -41,6 +41,7 @@ OBJS = \
 	lib/dwhciframeschednper.o \
 	lib/dwhciframeschedper.o \
 	lib/dwhciregister.o \
+	lib/dwhcirootport.o \
 	lib/dwhcixferstagedata.o \
 	lib/keymap.o \
 	lib/macaddress.o \
@@ -53,6 +54,7 @@ OBJS = \
 	lib/usbgamepad.o \
 	lib/usbkeyboard.o \
 	lib/usbmassdevice.o \
+	lib/usbmouse.o \
 	lib/usbrequest.o \
 	lib/usbstandardhub.o \
 	lib/uspilibrary.o \

uspi/README.md

@@ -13,10 +13,11 @@ USPi was "mechanically" ported from the Circle USB library which is written in C
 Interface
 ---------
 
-The USPi library provides functions to be used by the bare metal environment to access USB devices. There are four groups of functions which are declared in *include/uspi.h*:
+The USPi library provides functions to be used by the bare metal environment to access USB devices. There are five groups of functions which are declared in *include/uspi.h*:
 
 * USPi initialization
 * Keyboard
+* Mouse
 * USB Mass storage device
 * Ethernet controller
 

uspi/include/uspi.h

@@ -5,7 +5,7 @@
 //
 // USPi - An USB driver for Raspberry Pi written in C
 // Copyright (C) 2014  R. Stange <[email protected]>
-//
+// 
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
 // the Free Software Foundation, either version 3 of the License, or
@@ -63,7 +63,35 @@ void USPiKeyboardRegisterKeyStatusHandlerRaw (TUSPiKeyStatusHandlerRaw *pKeyStat
 // ucModifiers (bit is set if modifier key is pressed)
 #define LCTRL		(1 << 0)
 #define LSHIFT		(1 << 1)
-#define ALT		    (1 << 2)
+#define ALT		(1 << 2)
+#define LWIN		(1 << 3)
+#define RCTRL		(1 << 4)
+#define RSHIFT		(1 << 5)
+#define ALTGR		(1 << 6)
+#define RWIN		(1 << 7)
+
+//
+// Mouse device
+//
+
+// returns != 0 if available
+int USPiMouseAvailable (void);
+
+// The status handler is called when the mouse sends a status report.
+typedef void TUSPiMouseStatusHandler (unsigned nButtons,
+				      int nDisplacementX,		// -127..127
+				      int nDisplacementY);		// -127..127
+void USPiMouseRegisterStatusHandler (TUSPiMouseStatusHandler *pStatusHandler);
+
+// nButtons (bit is set if button is pressed)
+#define MOUSE_BUTTON1	(1 << 0)
+#define MOUSE_BUTTON2	(1 << 1)
+#define MOUSE_BUTTON3	(1 << 2)
+
+// ucModifiers (bit is set if modifier key is pressed)
+#define LCTRL		(1 << 0)
+#define LSHIFT		(1 << 1)
+#define ALT		(1 << 2)
 #define LWIN		(1 << 3)
 #define RCTRL		(1 << 4)
 #define RSHIFT		(1 << 5)

uspi/include/uspi/dwhci.h

@@ -1,6 +1,10 @@
 //
 // dwhci.h
 //
+// The information in this file is from the Linux HS OTG driver
+//	which is Copyright by Synopsys Inc.
+//	See the file lib/README!
+//
 // USPi - An USB driver for Raspberry Pi written in C
 // Copyright (C) 2014  R. Stange <[email protected]>
 // 
@@ -95,6 +99,13 @@
 #define DWHCI_CORE_HW_CFG2		(ARM_USB_CORE_BASE + 0x048)	// RO
 	#define DWHCI_CORE_HW_CFG2_OP_MODE(reg)			(((reg) >> 0) & 7)
 	#define DWHCI_CORE_HW_CFG2_ARCHITECTURE(reg)		(((reg) >> 3) & 3)
+	#define DWHCI_CORE_HW_CFG2_HS_PHY_TYPE(reg)		(((reg) >> 6) & 3)
+		#define DWHCI_CORE_HW_CFG2_HS_PHY_TYPE_NOT_SUPPORTED		0
+		#define DWHCI_CORE_HW_CFG2_HS_PHY_TYPE_UTMI			1
+		#define DWHCI_CORE_HW_CFG2_HS_PHY_TYPE_ULPI			2
+		#define DWHCI_CORE_HW_CFG2_HS_PHY_TYPE_UTMI_ULPI		3
+	#define DWHCI_CORE_HW_CFG2_FS_PHY_TYPE(reg)		(((reg) >> 8) & 3)
+		#define DWHCI_CORE_HW_CFG2_FS_PHY_TYPE_DEDICATED		1
 	#define DWHCI_CORE_HW_CFG2_NUM_HOST_CHANNELS(reg)	((((reg) >> 14) & 0xF) + 1)
 #define DWHCI_CORE_HW_CFG3		(ARM_USB_CORE_BASE + 0x04C)	// RO
 	#define DWHCI_CORE_HW_CFG3_DFIFO_DEPTH(reg)	(((reg) >> 16) & 0xFFFF)
@@ -123,6 +134,9 @@
 #define DWHCI_HOST_CFG			(ARM_USB_HOST_BASE + 0x000)
 	#define DWHCI_HOST_CFG_FSLS_PCLK_SEL__SHIFT	0
 	#define DWHCI_HOST_CFG_FSLS_PCLK_SEL__MASK	(3 << 0)
+		#define DWHCI_HOST_CFG_FSLS_PCLK_SEL_30_60_MHZ	0
+		#define DWHCI_HOST_CFG_FSLS_PCLK_SEL_48_MHZ	1
+		#define DWHCI_HOST_CFG_FSLS_PCLK_SEL_6_MHZ	2
 #define DWHCI_HOST_FRM_INTERVAL		(ARM_USB_HOST_BASE + 0x004)
 #define DWHCI_HOST_FRM_NUM		(ARM_USB_HOST_BASE + 0x008)
 	#define DWHCI_HOST_FRM_NUM_NUMBER(reg)			((reg) & 0xFFFF)
@@ -139,6 +153,7 @@
 	#define DWHCI_HOST_PORT_CONNECT_CHANGED			(1 << 1)
 	#define DWHCI_HOST_PORT_ENABLE				(1 << 2)
 	#define DWHCI_HOST_PORT_ENABLE_CHANGED			(1 << 3)
+	#define DWHCI_HOST_PORT_OVERCURRENT			(1 << 4)
 	#define DWHCI_HOST_PORT_OVERCURRENT_CHANGED		(1 << 5)
 	#define DWHCI_HOST_PORT_RESET				(1 << 8)
 	#define DWHCI_HOST_PORT_POWER				(1 << 12)

uspi/include/uspi/dwhcidevice.h

@@ -23,9 +23,11 @@
 #include <uspi/usb.h>
 #include <uspi/usbendpoint.h>
 #include <uspi/usbrequest.h>
+#include <uspi/dwhcirootport.h>
 #include <uspi/dwhcixferstagedata.h>
 #include <uspi/dwhciregister.h>
 #include <uspi/dwhci.h>
+#include <uspi/usb.h>
 #include <uspi/types.h>
 #include <uspios.h>
 
@@ -41,6 +43,8 @@ typedef struct TDWHCIDevice
 	TDWHCITransferStageData *m_pStageData[DWHCI_MAX_CHANNELS];
 
 	volatile boolean m_bWaiting;
+
+	TDWHCIRootPort m_RootPort;
 }
 TDWHCIDevice;
 
@@ -70,6 +74,10 @@ int DWHCIDeviceTransfer (TDWHCIDevice *pThis, TUSBEndpoint *pEndpoint, void *pBu
 boolean DWHCIDeviceSubmitBlockingRequest (TDWHCIDevice *pThis, TUSBRequest *pURB);
 boolean DWHCIDeviceSubmitAsyncRequest (TDWHCIDevice *pThis, TUSBRequest *pURB);
 
+TUSBSpeed DWHCIDeviceGetPortSpeed (TDWHCIDevice *pThis);
+boolean DWHCIDeviceOvercurrentDetected (TDWHCIDevice *pThis);
+void DWHCIDeviceDisableRootPort (TDWHCIDevice *pThis);
+
 #ifdef __cplusplus
 }
 #endif

uspi/include/uspi/dwhcirootport.h

@@ -0,0 +1,49 @@
+//
+// dwhcirootport.h
+//
+// USPi - An USB driver for Raspberry Pi written in C
+// Copyright (C) 2014  R. Stange <[email protected]>
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+#ifndef _uspi_dwhcirootport_h
+#define _uspi_dwhcirootport_h
+
+#include <uspi/usbdevice.h>
+#include <uspi/types.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct TDWHCIDevice;
+
+typedef struct TDWHCIRootPort
+{
+	struct TDWHCIDevice *m_pHost;
+
+	TUSBDevice *m_pDevice;
+}
+TDWHCIRootPort;
+
+void DWHCIRootPort (TDWHCIRootPort *pThis, struct TDWHCIDevice *pHost);
+void _DWHCIRootPort (TDWHCIRootPort *pThis);
+
+boolean DWHCIRootPortInitialize (TDWHCIRootPort *pThis);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

uspi/include/uspi/types.h

@@ -3,7 +3,7 @@
 //
 // USPi - An USB driver for Raspberry Pi written in C
 // Copyright (C) 2014  R. Stange <[email protected]>
-//
+// 
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
 // the Free Software Foundation, either version 3 of the License, or

uspi/include/uspi/usbhid.h

@@ -3,7 +3,7 @@
 //
 // USPi - An USB driver for Raspberry Pi written in C
 // Copyright (C) 2014  R. Stange <[email protected]>
-//
+// 
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
 // the Free Software Foundation, either version 3 of the License, or
@@ -70,4 +70,9 @@ PACKED TUSBHIDDescriptor;
 #define LED_CAPS_LOCK	(1 << 1)
 #define LED_SCROLL_LOCK	(1 << 2)
 
+// Mouse buttons (boot protocol)
+#define USBHID_BUTTON1	(1 << 0)
+#define USBHID_BUTTON2	(1 << 1)
+#define USBHID_BUTTON3	(1 << 2)
+
 #endif

uspi/include/uspi/usbmouse.h

@@ -0,0 +1,55 @@
+//
+// usbmouse.h
+//
+// USPi - An USB driver for Raspberry Pi written in C
+// Copyright (C) 2014  R. Stange <[email protected]>
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+#ifndef _usbmouse_h
+#define _usbmouse_h
+
+#include <uspi/usbdevice.h>
+#include <uspi/usbendpoint.h>
+#include <uspi/usbrequest.h>
+#include <uspi/types.h>
+
+#define MOUSE_BOOT_REPORT_SIZE	3
+
+typedef void TMouseStatusHandler (unsigned nButtons, int nDisplacementX, int nDisplacementY);
+
+typedef struct TUSBMouseDevice
+{
+	TUSBDevice m_USBDevice;
+
+	u8 m_ucInterfaceNumber;
+	u8 m_ucAlternateSetting;
+
+	TUSBEndpoint *m_pReportEndpoint;
+
+	TMouseStatusHandler *m_pStatusHandler;
+
+	TUSBRequest *m_pURB;
+	u8 *m_pReportBuffer;
+}
+TUSBMouseDevice;
+
+void USBMouseDevice (TUSBMouseDevice *pThis, TUSBDevice *pDevice);
+void _CUSBMouseDevice (TUSBMouseDevice *pThis);
+
+boolean USBMouseDeviceConfigure (TUSBDevice *pUSBDevice);
+
+void USBMouseDeviceRegisterStatusHandler (TUSBMouseDevice *pThis, TMouseStatusHandler *pStatusHandler);
+
+#endif

uspi/include/uspi/usbstandardhub.h

@@ -43,12 +43,13 @@ typedef struct TUSBStandardHub
 }
 TUSBStandardHub;
 
-void USBStandardHub (TUSBStandardHub *pThis, TUSBHostController *pHost, TUSBSpeed Speed);
-void USBStandardHub2 (TUSBStandardHub *pThis, TUSBDevice *pDevice);
+void USBStandardHub (TUSBStandardHub *pThis, TUSBDevice *pDevice);
 void _USBStandardHub (TUSBStandardHub *pThis);
 
 boolean USBStandardHubInitialize (TUSBStandardHub *pThis);
-boolean USBStandardHubConfigure (TUSBStandardHub *pThis);
+boolean USBStandardHubConfigure (TUSBDevice *pUSBDevice);
+
+TString *USBStandardHubGetDeviceNames (TUSBDevice *pDevice);
 
 #ifdef __cplusplus
 }

uspi/include/uspi/uspilibrary.h

@@ -3,7 +3,7 @@
 //
 // USPi - An USB driver for Raspberry Pi written in C
 // Copyright (C) 2014  R. Stange <[email protected]>
-//
+// 
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
 // the Free Software Foundation, either version 3 of the License, or
@@ -22,11 +22,11 @@
 
 #include <uspi/devicenameservice.h>
 #include <uspi/dwhcidevice.h>
-#include <uspi/usbstandardhub.h>
 #include <uspi/usbkeyboard.h>
+#include <uspi/usbmouse.h>
+#include <uspi/usbgamepad.h>
 #include <uspi/usbmassdevice.h>
 #include <uspi/smsc951x.h>
-#include <uspi/usbgamepad.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -36,8 +36,8 @@ typedef struct TUSPiLibrary
 {
 	TDeviceNameService		 NameService;
 	TDWHCIDevice			 DWHCI;
-	TUSBStandardHub			 USBHub1;
 	TUSBKeyboardDevice		*pUKBD1;
+	TUSBMouseDevice			*pUMouse1;
 	TUSBBulkOnlyMassStorageDevice	*pUMSD1;
 	TSMSC951xDevice			*pEth0;
     TUSBGamePadDevice       *pUPAD1;

uspi/include/uspi/util.h

@@ -57,6 +57,8 @@ char *strncpy (char *pDest, const char *pSrc, size_t nMaxLen);
 
 char *strcat (char *pDest, const char *pSrc);
 
+int uspi_char2int (char chValue);		// with sign extension
+
 u16 uspi_le2be16 (u16 usValue);
 
 u32 uspi_le2be32 (u32 ulValue);