XBOXOLD.h

Go to the documentation of this file.

/* Copyright (C) 2013 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 _xboxold_h_
#define _xboxold_h_
 
#include "Usb.h"
#include "usbhid.h"
#include "controllerEnums.h"
 
/* Data Xbox taken from descriptors */
#define EP_MAXPKTSIZE       32 // Max size for data via USB
 
/* Names we give to the 3 Xbox 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 LOGITECH_VID                            0x046D // For official Logitech controllers
 
#define XBOX_OLD_PID1                           0x0202 // Original Microsoft Xbox controller (US)
#define XBOX_OLD_PID2                           0x0285 // Original Microsoft Xbox controller (Japan)
#define XBOX_OLD_PID3                           0x0287 // Microsoft Microsoft Xbox Controller S
#define XBOX_OLD_PID4                           0x0289 // Smaller Microsoft Xbox controller (US)
#define XBOX_OLD_PID5                           0xCA84 // Logitech Cordless Precision controller
 
#define XBOX_MAX_ENDPOINTS   3
 
class XBOXOLD : public USBDeviceConfig, public UsbConfigXtracter {
public:
        XBOXOLD(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;
        };
 
        uint8_t readPollInterval() {
                return pollInterval;
        };
 
        virtual bool VIDPIDOK(uint16_t vid, uint16_t pid) {
                return ((vid == XBOX_VID || vid == MADCATZ_VID || vid == JOYTECH_VID || vid == LOGITECH_VID) && (pid == XBOX_OLD_PID1 || pid == XBOX_OLD_PID2 || pid == XBOX_OLD_PID3 || pid == XBOX_OLD_PID4 || pid == XBOX_OLD_PID5));
        };
        uint8_t getButtonPress(ButtonEnum b);
        bool getButtonClick(ButtonEnum b);
        int16_t getAnalogHat(AnalogHatEnum a);
 
        void setRumbleOff() {
                setRumbleOn(0, 0);
        };
        void setRumbleOn(uint8_t lValue, uint8_t rValue);
 
        void attachOnInit(void (*funcOnInit)(void)) {
                pFuncOnInit = funcOnInit;
        };
        bool XboxConnected;
 
protected:
        USB *pUsb;
        uint8_t bAddress;
        EpInfo epInfo[XBOX_MAX_ENDPOINTS];
 
        uint8_t bConfNum;
        uint8_t bNumEP;
        uint32_t qNextPollTime;
 
        void EndpointXtract(uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const USB_ENDPOINT_DESCRIPTOR *ep);
        void PrintEndpointDescriptor(const USB_ENDPOINT_DESCRIPTOR* ep_ptr);
 
private:
        static int8_t getAnalogIndex(ButtonEnum b);
        static int8_t getDigitalIndex(ButtonEnum b);
 
        void (*pFuncOnInit)(void); // Pointer to function called in onInit()
 
        uint8_t pollInterval;
        bool bPollEnable;
 
        /* Variables to store the digital buttons */
        uint8_t ButtonState;
        uint8_t OldButtonState;
        uint8_t ButtonClickState;
 
        /* Variables to store the analog buttons */
        uint8_t buttonValues[8]; // A, B, X, Y, BLACK, WHITE, L1, and R1
        uint8_t oldButtonValues[8];
        bool buttonClicked[8];
 
        int16_t hatValue[4]; // Joystick values
 
        uint8_t readBuf[EP_MAXPKTSIZE]; // General purpose buffer for input data
 
        void readReport(); // Read incoming data
        void printReport(uint16_t length); // Print incoming date
 
        /* Private commands */
        void XboxCommand(uint8_t* data, uint16_t nbytes);
};
#endif