XBOXUSB.h

Go to the documentation of this file.

/* Copyright (C) 2012 Kristian Lauszus, TKJ Electronics. All rights reserved.
 
 This software may be distributed and modified under the terms of the GNU
 General Public License version 2 (GPL2) as published by the Free Software
 Foundation and appearing in the file GPL2.TXT included in the packaging of
 this file. Please note that GPL2 Section 2[b] requires that all works based
 on this software must also be made publicly available under the terms of
 the GPL2 ("Copyleft").
 
 Contact information
 -------------------
 
 Kristian Lauszus, TKJ Electronics
 Web      :  http://www.tkjelectronics.com
 e-mail   :  kristianl@tkjelectronics.com
 */
 
#ifndef _xboxusb_h_
#define _xboxusb_h_
 
#include "Usb.h"
#include "usbhid.h"
#include "xboxEnums.h"
 
/* Data Xbox 360 taken from descriptors */
#define EP_MAXPKTSIZE       32 // max size for data via USB
 
/* Names we give to the 3 Xbox360 pipes */
#define XBOX_CONTROL_PIPE    0
#define XBOX_INPUT_PIPE      1
#define XBOX_OUTPUT_PIPE     2
 
// PID and VID of the different devices
#define XBOX_VID                                0x045E // Microsoft Corporation
#define MADCATZ_VID                             0x1BAD // For unofficial Mad Catz controllers
#define JOYTECH_VID                             0x162E // For unofficial Joytech controllers
#define GAMESTOP_VID                            0x0E6F // Gamestop controller
 
#define XBOX_WIRED_PID                          0x028E // Microsoft 360 Wired controller
#define XBOX_WIRELESS_PID                       0x028F // Wireless controller only support charging
#define XBOX_WIRELESS_RECEIVER_PID              0x0719 // Microsoft Wireless Gaming Receiver
#define XBOX_WIRELESS_RECEIVER_THIRD_PARTY_PID  0x0291 // Third party Wireless Gaming Receiver
#define MADCATZ_WIRED_PID                       0xF016 // Mad Catz wired controller
#define JOYTECH_WIRED_PID                       0xBEEF // For Joytech wired controller
#define GAMESTOP_WIRED_PID                      0x0401 // Gamestop wired controller
#define AFTERGLOW_WIRED_PID                     0x0213 // Afterglow wired controller - it uses the same VID as a Gamestop controller
 
#define XBOX_REPORT_BUFFER_SIZE 14 // Size of the input report buffer
 
#define XBOX_MAX_ENDPOINTS   3
 
class XBOXUSB : public USBDeviceConfig {
public:
        XBOXUSB(USB *pUsb);
 
        uint8_t Init(uint8_t parent, uint8_t port, bool lowspeed);
        uint8_t Release();
        uint8_t Poll();
 
        virtual uint8_t GetAddress() {
                return bAddress;
        };
 
        virtual bool isReady() {
                return bPollEnable;
        };
 
        virtual bool VIDPIDOK(uint16_t vid, uint16_t pid) {
                return ((vid == XBOX_VID || vid == MADCATZ_VID || vid == JOYTECH_VID || vid == GAMESTOP_VID) && (pid == XBOX_WIRED_PID || pid == MADCATZ_WIRED_PID || pid == GAMESTOP_WIRED_PID || pid == AFTERGLOW_WIRED_PID || pid == JOYTECH_WIRED_PID));
        };
        uint8_t getButtonPress(ButtonEnum b);
        bool getButtonClick(ButtonEnum b);
        int16_t getAnalogHat(AnalogHatEnum a);
 
        void setAllOff() {
                setRumbleOn(0, 0);
                setLedRaw(0);
        };
 
        void setRumbleOff() {
                setRumbleOn(0, 0);
        };
        void setRumbleOn(uint8_t lValue, uint8_t rValue);
        void setLedRaw(uint8_t value);
 
        void setLedOff() {
                setLedRaw(0);
        };
        void setLedOn(LEDEnum l);
        void setLedBlink(LEDEnum l);
        void setLedMode(LEDModeEnum lm);
 
        void attachOnInit(void (*funcOnInit)(void)) {
                pFuncOnInit = funcOnInit;
        };
        bool Xbox360Connected;
 
protected:
        USB *pUsb;
        uint8_t bAddress;
        EpInfo epInfo[XBOX_MAX_ENDPOINTS];
 
private:
        void onInit();
        void (*pFuncOnInit)(void); // Pointer to function called in onInit()
 
        bool bPollEnable;
 
        /* Variables to store the buttons */
        uint32_t ButtonState;
        uint32_t OldButtonState;
        uint16_t ButtonClickState;
        int16_t hatValue[4];
        uint16_t controllerStatus;
 
        bool L2Clicked; // These buttons are analog, so we use we use these bools to check if they where clicked or not
        bool R2Clicked;
 
        uint8_t readBuf[EP_MAXPKTSIZE]; // General purpose buffer for input data
        uint8_t writeBuf[8]; // General purpose buffer for output data
 
        void readReport(); // read incoming data
        void printReport(); // print incoming date - Uncomment for debugging
 
        /* Private commands */
        void XboxCommand(uint8_t* data, uint16_t nbytes);
};
#endif