UsbHubDevice.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef USBHUBDEVICE_H
#define USBHUBDEVICE_H

#include "modules/system/usb/Usb.h"
#include "modules/system/usb/UsbConstants.h"
#include "modules/system/usb/UsbDevice.h"
#include "modules/system/usb/UsbHub.h"
#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/String.h"

class UsbHubDevice : public UsbDevice, public UsbHub
{
  public:
    UsbHubDevice(UsbDevice *dev);
    virtual ~UsbHubDevice();

    virtual void initialiseDriver();

    virtual void getName(String &str)
    {
        str = "USB Hub Device";
    }

    virtual void addTransferToTransaction(
        uintptr_t pTransaction, bool bToggle, UsbPid pid, uintptr_t pBuffer,
        size_t nBytes);
    virtual uintptr_t createTransaction(UsbEndpoint endpointInfo);
    virtual void doAsync(
        uintptr_t pTransaction, void (*pCallback)(uintptr_t, ssize_t) = 0,
        uintptr_t pParam = 0);
    virtual void addInterruptInHandler(
        UsbEndpoint endpointInfo, uintptr_t pBuffer, uint16_t nBytes,
        void (*pCallback)(uintptr_t, ssize_t), uintptr_t pParam = 0);

    virtual bool portReset(uint8_t nPort, bool bErrorResponse = false);

  private:
    enum HubFeatureSelectors
    {
        HubLocalPower = 0,
        HubOverCurrent = 1,
    };

    enum PortFeatureSelectors
    {
        PortConnection = 0,
        PortEnable = 1,
        PortSuspend = 2,
        PortOverCurrent = 3,
        PortReset = 4,
        PortPower = 8,
        PortLowSpeed = 9,
        CPortConnection = 16,
        CPortEnable = 17,
        CPortSuspend = 18,
        CPortOverCurrent = 19,
        CPortReset = 20,
        PortTest = 21,
        PortIndicator = 22,
    };

    enum HubRequests
    {
        HubPortRequest = UsbRequestType::Class | UsbRequestRecipient::Other
    };

    bool setPortFeature(size_t port, PortFeatureSelectors feature);
    bool clearPortFeature(size_t port, PortFeatureSelectors feature);

    uint32_t getPortStatus(size_t port);

    struct HubDescriptor
    {
        inline HubDescriptor(void *pBuffer)
            : pDescriptor(static_cast<Descriptor *>(pBuffer)),
              nPorts(pDescriptor->nPorts),
              hubCharacteristics(pDescriptor->hubCharacteristics)
        {
        }

        struct Descriptor
        {
            uint8_t nLength;
            uint8_t nType;
            uint8_t nPorts;
            uint16_t hubCharacteristics;
        } PACKED *pDescriptor;

        uint8_t nPorts;
        uint16_t hubCharacteristics;
    };

    size_t m_nPorts;
};

#endif