roothub.c File Reference

#include "usbuhci.h"
#include <debug.h>

Include dependency graph for roothub.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
VOID NTAPI	UhciRHGetRootHubData (IN PVOID uhciExtension, IN PVOID rootHubData)
MPSTATUS NTAPI	UhciRHGetStatus (IN PVOID uhciExtension, IN PUSHORT Status)
MPSTATUS NTAPI	UhciRHGetPortStatus (IN PVOID uhciExtension, IN USHORT Port, IN PUSB_PORT_STATUS_AND_CHANGE PortStatus)
MPSTATUS NTAPI	UhciRHGetHubStatus (IN PVOID uhciExtension, IN PUSB_HUB_STATUS_AND_CHANGE HubStatus)
VOID NTAPI	UhciRHPortResetComplete (IN PVOID uhciExtension, IN PVOID pPort)
VOID NTAPI	UhciRHSetFeaturePortResetWorker (IN PUHCI_EXTENSION UhciExtension, IN PUSHORT pPort)
MPSTATUS NTAPI	UhciRHSetFeaturePortReset (IN PVOID uhciExtension, IN USHORT Port)
MPSTATUS NTAPI	UhciRHSetFeaturePortPower (IN PVOID uhciExtension, IN USHORT Port)
MPSTATUS NTAPI	UhciRHPortEnable (IN PVOID uhciExtension, IN USHORT Port, IN BOOLEAN IsSet)
MPSTATUS NTAPI	UhciRHSetFeaturePortEnable (IN PVOID uhciExtension, IN USHORT Port)
MPSTATUS NTAPI	UhciRHSetFeaturePortSuspend (IN PVOID uhciExtension, IN USHORT Port)
MPSTATUS NTAPI	UhciRHClearFeaturePortEnable (IN PVOID uhciExtension, IN USHORT Port)
MPSTATUS NTAPI	UhciRHClearFeaturePortPower (IN PVOID uhciExtension, IN USHORT Port)
MPSTATUS NTAPI	UhciRHClearFeaturePortSuspend (IN PVOID uhciExtension, IN USHORT Port)
MPSTATUS NTAPI	UhciRHClearFeaturePortEnableChange (IN PVOID uhciExtension, IN USHORT Port)
MPSTATUS NTAPI	UhciRHClearFeaturePortConnectChange (IN PVOID uhciExtension, IN USHORT Port)
MPSTATUS NTAPI	UhciRHClearFeaturePortResetChange (IN PVOID uhciExtension, IN USHORT Port)
MPSTATUS NTAPI	UhciRHClearFeaturePortSuspendChange (IN PVOID uhciExtension, IN USHORT Port)
MPSTATUS NTAPI	UhciRHClearFeaturePortOvercurrentChange (IN PVOID uhciExtension, IN USHORT Port)
VOID NTAPI	UhciRHDisableIrq (IN PVOID uhciExtension)
VOID NTAPI	UhciRHEnableIrq (IN PVOID uhciExtension)

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 10 of file roothub.c.

Function Documentation

UhciRHClearFeaturePortConnectChange()

MPSTATUS NTAPI UhciRHClearFeaturePortConnectChange	(	IN PVOID	uhciExtension,
		IN USHORT	Port
	)

Definition at line 406 of file roothub.c.

{
    PUHCI_EXTENSION UhciExtension = uhciExtension;
    PUHCI_HW_REGISTERS BaseRegister;
    PUSHORT PortControlRegister;
    UHCI_PORT_STATUS_CONTROL PortControl;

    DPRINT("UhciRHClearFeaturePortConnectChange: Port - %04X\n", Port);

    ASSERT(Port);

    BaseRegister = UhciExtension->BaseRegister;
    PortControlRegister = (PUSHORT)&BaseRegister->PortControl[Port - 1];
    PortControl.AsUSHORT = READ_PORT_USHORT(PortControlRegister);

    if (PortControl.ConnectStatusChange == 1)
    {
        /* WC (Write Clear) bits */
        PortControl.PortEnableDisableChange = 0;
        PortControl.ConnectStatusChange = 1;
        WRITE_PORT_USHORT(PortControlRegister, PortControl.AsUSHORT);
    }

    return MP_STATUS_SUCCESS;
}

Referenced by DriverEntry().

UhciRHClearFeaturePortEnable()

MPSTATUS NTAPI UhciRHClearFeaturePortEnable	(	IN PVOID	uhciExtension,
		IN USHORT	Port
	)

Definition at line 350 of file roothub.c.

{
    PUHCI_EXTENSION UhciExtension = uhciExtension;
    DPRINT("UhciRHClearFeaturePortEnable: ...\n");
    ASSERT(Port);
    return UhciRHPortEnable(UhciExtension, Port, FALSE);
}

Referenced by DriverEntry().

UhciRHClearFeaturePortEnableChange()

MPSTATUS NTAPI UhciRHClearFeaturePortEnableChange	(	IN PVOID	uhciExtension,
		IN USHORT	Port
	)

Definition at line 381 of file roothub.c.

{
    PUHCI_EXTENSION UhciExtension = uhciExtension;
    PUHCI_HW_REGISTERS BaseRegister;
    PUSHORT PortControlRegister;
    UHCI_PORT_STATUS_CONTROL PortControl;

    DPRINT("UhciRHClearFeaturePortEnableChange: ...\n");

    ASSERT(Port);

    BaseRegister = UhciExtension->BaseRegister;
    PortControlRegister = (PUSHORT)&BaseRegister->PortControl[Port - 1];
    PortControl.AsUSHORT = READ_PORT_USHORT(PortControlRegister);

    PortControl.ConnectStatusChange = 0;
    PortControl.PortEnableDisableChange = 1;
    WRITE_PORT_USHORT(PortControlRegister, PortControl.AsUSHORT);

    return MP_STATUS_SUCCESS;
}

Referenced by DriverEntry().

UhciRHClearFeaturePortOvercurrentChange()

MPSTATUS NTAPI UhciRHClearFeaturePortOvercurrentChange	(	IN PVOID	uhciExtension,
		IN USHORT	Port
	)

Definition at line 457 of file roothub.c.

{
    DPRINT("UhciRHClearFeaturePortOvercurrentChange: UNIMPLEMENTED. FIXME\n");
    ASSERT(Port);
    return MP_STATUS_SUCCESS;
}

Referenced by DriverEntry().

UhciRHClearFeaturePortPower()

MPSTATUS NTAPI UhciRHClearFeaturePortPower	(	IN PVOID	uhciExtension,
		IN USHORT	Port
	)

Definition at line 361 of file roothub.c.

{
    DPRINT("UhciRHClearFeaturePortPower: UNIMPLEMENTED. FIXME\n");
    ASSERT(Port);
    return MP_STATUS_SUCCESS;
}

Referenced by DriverEntry().

UhciRHClearFeaturePortResetChange()

MPSTATUS NTAPI UhciRHClearFeaturePortResetChange	(	IN PVOID	uhciExtension,
		IN USHORT	Port
	)

Definition at line 435 of file roothub.c.

{
    PUHCI_EXTENSION UhciExtension = uhciExtension;
    DPRINT("UhciRHClearFeaturePortResetChange: ...\n");
    ASSERT(Port);
    UhciExtension->ResetChangePortMask &= ~(1 << (Port - 1));
    return MP_STATUS_SUCCESS;
}

Referenced by DriverEntry().

UhciRHClearFeaturePortSuspend()

MPSTATUS NTAPI UhciRHClearFeaturePortSuspend	(	IN PVOID	uhciExtension,
		IN USHORT	Port
	)

Definition at line 371 of file roothub.c.

{
    DPRINT("UhciRHClearFeaturePortSuspend: UNIMPLEMENTED. FIXME\n");
    ASSERT(Port);
    return MP_STATUS_SUCCESS;
}

Referenced by DriverEntry().

UhciRHClearFeaturePortSuspendChange()

MPSTATUS NTAPI UhciRHClearFeaturePortSuspendChange	(	IN PVOID	uhciExtension,
		IN USHORT	Port
	)

Definition at line 447 of file roothub.c.

{
    DPRINT("UhciRHClearFeaturePortSuspendChange: UNIMPLEMENTED. FIXME\n");
    ASSERT(Port);
    return MP_STATUS_SUCCESS;
}

Referenced by DriverEntry().

UhciRHDisableIrq()

VOID NTAPI UhciRHDisableIrq

(

IN PVOID

uhciExtension

)

Definition at line 467 of file roothub.c.

{
    /* Do nothing */
    return;
}

Referenced by DriverEntry().

UhciRHEnableIrq()

VOID NTAPI UhciRHEnableIrq

(

IN PVOID

uhciExtension

)

Definition at line 475 of file roothub.c.

{
    /* Do nothing */
    return;
}

Referenced by DriverEntry().

UhciRHGetHubStatus()

MPSTATUS NTAPI UhciRHGetHubStatus	(	IN PVOID	uhciExtension,
		IN PUSB_HUB_STATUS_AND_CHANGE	HubStatus
	)

Definition at line 137 of file roothub.c.

{
    //DPRINT("UhciRHGetHubStatus: ...\n");
    HubStatus->AsUlong32 = 0;
    return MP_STATUS_SUCCESS;
}

Referenced by DriverEntry().

UhciRHGetPortStatus()

MPSTATUS NTAPI UhciRHGetPortStatus	(	IN PVOID	uhciExtension,
		IN USHORT	Port,
		IN PUSB_PORT_STATUS_AND_CHANGE	PortStatus
	)

Definition at line 50 of file roothub.c.

{
    PUHCI_EXTENSION UhciExtension = uhciExtension;
    PUHCI_HW_REGISTERS BaseRegister;
    PUSHORT PortControlRegister;
    UHCI_PORT_STATUS_CONTROL PortControl;
    ULONG PortBit;
    USB_20_PORT_STATUS portStatus;
    USB_20_PORT_CHANGE portChange;

    //DPRINT("UhciRHGetPortStatus: ...\n");

    ASSERT(Port);

    BaseRegister = UhciExtension->BaseRegister;
    PortControlRegister = &BaseRegister->PortControl[Port-1].AsUSHORT;
    PortControl.AsUSHORT = READ_PORT_USHORT(PortControlRegister);

    portStatus.AsUshort16 = 0;
    portChange.AsUshort16 = 0;

    portStatus.CurrentConnectStatus = PortControl.CurrentConnectStatus;
    portStatus.PortEnabledDisabled = PortControl.PortEnabledDisabled;

    if (PortControl.Suspend == 1 &&
        PortControl.PortEnabledDisabled == 1)
    {
        portStatus.Suspend = 1;
    }
    else
    {
        portStatus.Suspend = 0;
    }

    //if (UhciExtension->HcFlavor == UHCI_Piix4) // check will work after supporting HcFlavor in usbport.
    if (TRUE)
    {
        portStatus.OverCurrent = PortControl.Reserved2 & 1;
        portStatus.PortPower = (~PortControl.Reserved2 & 1);
        portChange.OverCurrentIndicatorChange = (PortControl.Reserved2 & 2) != 0;
    }
    else
    {
        portStatus.OverCurrent = 0;
        portStatus.PortPower = 1;
        portChange.OverCurrentIndicatorChange = 0;
    }

    portStatus.HighSpeedDeviceAttached = 0;

    portStatus.Reset = PortControl.PortReset;
    portStatus.LowSpeedDeviceAttached = PortControl.LowSpeedDevice;
    portChange.ConnectStatusChange = PortControl.ConnectStatusChange;

    PortBit = 1 << (Port - 1);

    if (UhciExtension->ResetPortMask & PortBit)
    {
        portChange.ConnectStatusChange = 0;
        portChange.PortEnableDisableChange = 0;
    }
    else
    {
        portChange.PortEnableDisableChange = PortControl.PortEnableDisableChange;
    }

    if (UhciExtension->SuspendChangePortMask & PortBit)
        portChange.SuspendChange = 1;

    if (UhciExtension->ResetChangePortMask & PortBit)
        portChange.ResetChange = 1;

    PortStatus->PortStatus.Usb20PortStatus = portStatus;
    PortStatus->PortChange.Usb20PortChange = portChange;

    //DPRINT("UhciRHGetPortStatus: PortControl.AsUSHORT[%x] - %X, PortStatus - %X\n",
    //       Port,
    //       PortControl.AsUSHORT,
    //       PortStatus->AsUlong32);

    return MP_STATUS_SUCCESS;
}

Referenced by DriverEntry().

UhciRHGetRootHubData()

VOID NTAPI UhciRHGetRootHubData	(	IN PVOID	uhciExtension,
		IN PVOID	rootHubData
	)

Definition at line 15 of file roothub.c.

{
    PUHCI_EXTENSION UhciExtension = uhciExtension;
    PUSBPORT_ROOT_HUB_DATA RootHubData = rootHubData;
    USBPORT_HUB_11_CHARACTERISTICS HubCharacteristics;

    DPRINT("UhciRHGetRootHubData: ...\n");

    HubCharacteristics.AsUSHORT = 0;
    HubCharacteristics.PowerControlMode = 1;
    HubCharacteristics.NoPowerSwitching = 1;
    HubCharacteristics.OverCurrentProtectionMode = 1;

    if (UhciExtension->HcFlavor != UHCI_Piix4)
        HubCharacteristics.NoOverCurrentProtection = 1;

    RootHubData->NumberOfPorts = UHCI_NUM_ROOT_HUB_PORTS;
    RootHubData->HubCharacteristics.Usb11HubCharacteristics = HubCharacteristics;
    RootHubData->PowerOnToPowerGood = 1;
    RootHubData->HubControlCurrent = 0;
}

Referenced by DriverEntry().

UhciRHGetStatus()

MPSTATUS NTAPI UhciRHGetStatus	(	IN PVOID	uhciExtension,
		IN PUSHORT	Status
	)

Definition at line 40 of file roothub.c.

{
    DPRINT("UhciRHGetStatus: ...\n");
    *Status = USB_GETSTATUS_SELF_POWERED;
    return MP_STATUS_SUCCESS;
}

Referenced by DriverEntry().

UhciRHPortEnable()

MPSTATUS NTAPI UhciRHPortEnable	(	IN PVOID	uhciExtension,
		IN USHORT	Port,
		IN BOOLEAN	IsSet
	)

Definition at line 296 of file roothub.c.

{
    PUHCI_EXTENSION UhciExtension = uhciExtension;
    PUHCI_HW_REGISTERS BaseRegister;
    PUSHORT PortControlRegister;
    UHCI_PORT_STATUS_CONTROL PortControl;

    DPRINT("UhciRHPortEnable: ...\n");

    ASSERT(Port);

    BaseRegister = UhciExtension->BaseRegister;
    PortControlRegister = &BaseRegister->PortControl[Port-1].AsUSHORT;

    PortControl.AsUSHORT = READ_PORT_USHORT(PortControlRegister);

    PortControl.ConnectStatusChange = 0;
    PortControl.PortEnableDisableChange = 0;

    if (IsSet)
        PortControl.PortEnabledDisabled = 1;
    else
        PortControl.PortEnabledDisabled = 0;

    WRITE_PORT_USHORT(PortControlRegister, PortControl.AsUSHORT);

    return MP_STATUS_SUCCESS;
}

Referenced by UhciRHClearFeaturePortEnable(), and UhciRHSetFeaturePortEnable().

UhciRHPortResetComplete()

VOID NTAPI UhciRHPortResetComplete	(	IN PVOID	uhciExtension,
		IN PVOID	pPort
	)

Definition at line 147 of file roothub.c.

{
    PUHCI_EXTENSION UhciExtension = uhciExtension;
    ULONG ix;
    PUHCI_HW_REGISTERS BaseRegister;
    PUSHORT PortControlRegister;
    UHCI_PORT_STATUS_CONTROL PortControl;
    USHORT Port;

    DPRINT("UhciRHPortResetComplete: ...\n");

    BaseRegister = UhciExtension->BaseRegister;

    Port = *(PUSHORT)pPort;
    ASSERT(Port);

    PortControlRegister = &BaseRegister->PortControl[Port - 1].AsUSHORT;
    PortControl.AsUSHORT = READ_PORT_USHORT(PortControlRegister);

    PortControl.ConnectStatusChange = 0;
    PortControl.PortEnableDisableChange = 0;
    PortControl.PortReset = 0;

    WRITE_PORT_USHORT(PortControlRegister, PortControl.AsUSHORT);

    while (UhciHardwarePresent(UhciExtension))
    {
        PortControl.AsUSHORT = READ_PORT_USHORT(PortControlRegister);

        if (PortControl.PortReset == 0)
            break;
    }

    for (ix = 0; ix < 10; ++ix)
    {
        KeStallExecutionProcessor(50);

        PortControl.AsUSHORT = READ_PORT_USHORT(PortControlRegister);

        if (PortControl.PortEnabledDisabled == 1)
            break;

        PortControl.PortEnabledDisabled = 1;
        WRITE_PORT_USHORT(PortControlRegister, PortControl.AsUSHORT);
    }

    PortControl.ConnectStatusChange = 1;
    PortControl.PortEnableDisableChange = 1;
    WRITE_PORT_USHORT(PortControlRegister, PortControl.AsUSHORT);

    if (UhciExtension->HcFlavor == UHCI_VIA ||
        UhciExtension->HcFlavor == UHCI_VIA_x01 ||
        UhciExtension->HcFlavor == UHCI_VIA_x02 ||
        UhciExtension->HcFlavor == UHCI_VIA_x03 ||
        UhciExtension->HcFlavor == UHCI_VIA_x04)
    {
        DPRINT1("UhciRHPortResetComplete: Via chip. FIXME\n");
        DbgBreakPoint();
        return;
    }

    UhciExtension->ResetChangePortMask |= (1 << (Port - 1));
    UhciExtension->ResetPortMask &= ~(1 << (Port - 1));

    RegPacket.UsbPortInvalidateRootHub(UhciExtension);
}

Referenced by UhciRHSetFeaturePortResetWorker().

UhciRHSetFeaturePortEnable()

MPSTATUS NTAPI UhciRHSetFeaturePortEnable	(	IN PVOID	uhciExtension,
		IN USHORT	Port
	)

Definition at line 329 of file roothub.c.

{
    PUHCI_EXTENSION UhciExtension = uhciExtension;
    DPRINT("UhciRHSetFeaturePortEnable: ...\n");
    ASSERT(Port);
    return UhciRHPortEnable(UhciExtension, Port, TRUE);
}

Referenced by DriverEntry().

UhciRHSetFeaturePortPower()

MPSTATUS NTAPI UhciRHSetFeaturePortPower	(	IN PVOID	uhciExtension,
		IN USHORT	Port
	)

Definition at line 286 of file roothub.c.

{
    DPRINT("UhciRHSetFeaturePortPower: ...\n");
    ASSERT(Port);
    return MP_STATUS_SUCCESS;
}

Referenced by DriverEntry().

UhciRHSetFeaturePortReset()

MPSTATUS NTAPI UhciRHSetFeaturePortReset	(	IN PVOID	uhciExtension,
		IN USHORT	Port
	)

Definition at line 250 of file roothub.c.

{
    PUHCI_EXTENSION UhciExtension = uhciExtension;
    ULONG ResetPortMask;
    ULONG PortBit;

    DPRINT("UhciRHSetFeaturePortReset: ...\n");

    ASSERT(Port);

    ResetPortMask = UhciExtension->ResetPortMask;
    PortBit = 1 << (Port - 1);

    if (ResetPortMask & PortBit)
        return MP_STATUS_FAILURE;

    UhciExtension->ResetPortMask = ResetPortMask | PortBit;

    if (UhciExtension->HcFlavor == UHCI_VIA ||
        UhciExtension->HcFlavor == UHCI_VIA_x01 ||
        UhciExtension->HcFlavor == UHCI_VIA_x02 ||
        UhciExtension->HcFlavor == UHCI_VIA_x03 ||
        UhciExtension->HcFlavor == UHCI_VIA_x04)
    {
        DPRINT1("UhciRHSetFeaturePortReset: Via chip. FIXME\n");
        return MP_STATUS_SUCCESS;
    }

    UhciRHSetFeaturePortResetWorker(UhciExtension, &Port);

    return MP_STATUS_SUCCESS;
}

Referenced by DriverEntry().

UhciRHSetFeaturePortResetWorker()

VOID NTAPI UhciRHSetFeaturePortResetWorker	(	IN PUHCI_EXTENSION	UhciExtension,
		IN PUSHORT	pPort
	)

Definition at line 217 of file roothub.c.

{
    PUHCI_HW_REGISTERS BaseRegister;
    PUSHORT PortControlRegister;
    UHCI_PORT_STATUS_CONTROL PortControl;
    USHORT Port;

    DPRINT("UhciRHSetFeaturePortResetWorker: ...\n");

    BaseRegister = UhciExtension->BaseRegister;

    Port = *(PUSHORT)pPort;
    ASSERT(Port);

    PortControlRegister = &BaseRegister->PortControl[Port - 1].AsUSHORT;
    PortControl.AsUSHORT = READ_PORT_USHORT(PortControlRegister);

    PortControl.ConnectStatusChange = 0;
    PortControl.PortEnableDisableChange = 0;
    PortControl.PortReset = 1;

    WRITE_PORT_USHORT(PortControlRegister, PortControl.AsUSHORT);

    RegPacket.UsbPortRequestAsyncCallback(UhciExtension,
                                          10, // TimerValue
                                          pPort,
                                          sizeof(*pPort),
                                          UhciRHPortResetComplete);
}

Referenced by UhciRHSetFeaturePortReset().

UhciRHSetFeaturePortSuspend()

MPSTATUS NTAPI UhciRHSetFeaturePortSuspend	(	IN PVOID	uhciExtension,
		IN USHORT	Port
	)

Definition at line 340 of file roothub.c.

{
    DPRINT("UhciRHSetFeaturePortSuspend: UNIMPLEMENTED. FIXME\n");
    ASSERT(Port);
    return MP_STATUS_SUCCESS;
}

Referenced by DriverEntry().