Subversion Repositories Kolibri OS

; Code for EHCI controllers.

; Note: it should be moved to an external driver,

; it was convenient to have this code compiled into the kernel during initial

; development, but there are no reasons to keep it here.

; =============================================================================

; ================================= Constants =================================

; =============================================================================

; EHCI register declarations.

; Part 1. Capability registers.

; Base is MMIO from the PCI space.

EhciCapLengthReg    = 0

EhciVersionReg      = 2

EhciStructParamsReg = 4

EhciCapParamsReg    = 8

EhciPortRouteReg    = 0Ch

; Part 2. Operational registers.

; Base is (base for part 1) + (value of EhciCapLengthReg).

EhciCommandReg      = 0

EhciStatusReg       = 4

EhciInterruptReg    = 8

EhciFrameIndexReg   = 0Ch

EhciCtrlDataSegReg  = 10h

EhciPeriodicListReg = 14h

EhciAsyncListReg    = 18h

EhciConfigFlagReg   = 40h

EhciPortsReg        = 44h

; Possible values of ehci_pipe.NextQH.Type bitfield.

EHCI_TYPE_ITD  = 0 ; isochronous transfer descriptor

EHCI_TYPE_QH   = 1 ; queue head

EHCI_TYPE_SITD = 2 ; split-transaction isochronous TD

EHCI_TYPE_FSTN = 3 ; frame span traversal node

; =============================================================================

; ================================ Structures =================================

; =============================================================================

; Hardware part of EHCI general transfer descriptor.

struct ehci_hardware_td

NextTD          dd      ?

; Bit 0 is Terminate bit, 1 = there is no next TD.

; Bits 1-4 must be zero.

; With masked 5 lower bits, this is the physical address of the next TD, if any.

AlternateNextTD dd      ?

; Similar to NextTD, used if the transfer terminates with a short packet.

Token           dd      ?

; 1. Lower byte is Status field:

; bit 0 = ping state for USB2 endpoints, ERR handshake signal for USB1 endpoints

; bit 1 = split transaction state, meaningless for USB2 endpoints

; bit 2 = missed micro-frame

; bit 3 = transaction error

; bit 4 = babble detected

; bit 5 = data buffer error

; bit 6 = halted

; bit 7 = active

; 2. Next two bits (bits 8-9) are PID code, 0 = OUT, 1 = IN, 2 = SETUP.

; 3. Next two bits (bits 10-11) is ErrorCounter. Initialized as 3, decremented

;    on each error; if it goes to zero, transaction is stopped.

; 4. Next 3 bits (bits 12-14) are CurrentPage field.

; 5. Next bit (bit 15) is InterruptOnComplete bit.

; 6. Next 15 bits (bits 16-30) are TransferLength field,

;    number of bytes to transfer.

; 7. Upper bit (bit 31) is DataToggle bit.

BufferPointers  rd      5

; The buffer to be transferred can be spanned on up to 5 physical pages.

; The first item of this array is the physical address of the first byte in

; the buffer, other items are physical addresses of next pages. Lower 12 bits

; in other items must be set to zero; ehci_pipe.Overlay reuses some of them.

BufferPointersHigh      rd      5

; Upper dwords of BufferPointers for controllers with 64-bit memory access.

; Always zero.

ends

; EHCI general transfer descriptor.

; * The structure describes transfers to be performed on Control, Bulk or

;   Interrupt endpoints.

; * The structure includes two parts, the hardware part and the software part.

; * The hardware part consists of first 52 bytes and corresponds to

;   the Queue Element Transfer Descriptor from EHCI specification.

; * The hardware requires 32-bytes alignment of the hardware part, so

;   the entire descriptor must be 32-bytes aligned. Since the allocator

;   (usb_allocate_common) allocates memory sequentially from page start

;   (aligned on 0x1000 bytes), block size for the allocator must be divisible

;   by 32; ehci_alloc_td ensures this.

; * The hardware also requires that the hardware part must not cross page

;   boundary; the allocator satisfies this automatically.

struct ehci_gtd ehci_hardware_td

Flags                   dd      ?

; Copy of flags from the call to usb_*_transfer_async.

ends

; EHCI-specific part of a pipe descriptor.

; * This structure corresponds to the Queue Head from the EHCI specification.

; * The hardware requires 32-bytes alignment of the hardware part.

;   Since the allocator (usb_allocate_common) allocates memory sequentially

;   from page start (aligned on 0x1000 bytes), block size for the allocator

;   must be divisible by 32; ehci_alloc_pipe ensures this.

; * The hardware requires also that the hardware part must not cross page

;   boundary; the allocator satisfies this automatically.

struct ehci_pipe

NextQH                  dd      ?

; 1. First bit (bit 0) is Terminate bit, 1 = there is no next QH.

; 2. Next two bits (bits 1-2) are Type field of the next QH,

;    one of EHCI_TYPE_* constants.

; 3. Next two bits (bits 3-4) are reserved, must be zero.

; 4. With masked 5 lower bits, this is the physical address of the next object

;    to be processed, usually next QH.

Token                   dd      ?

; 1. Lower 7 bits are DeviceAddress field. This is the address of the

;    target device on the USB bus.

; 2. Next bit (bit 7) is Inactivate-on-next-transaction bit. Can be nonzero

;    only for interrupt/isochronous USB1 endpoints.

; 3. Next 4 bits (bits 8-11) are Endpoint field. This is the target endpoint

;    number.

; 4. Next 2 bits (bits 12-13) are EndpointSpeed field, one of EHCI_SPEED_*.

; 5. Next bit (bit 14) is DataToggleControl bit,

;    0 = use DataToggle bit from QH, 1 = from TD.

; 6. Next bit (bit 15) is Head-of-reclamation-list. The head of Control list

;    has 1 here, all other QHs have zero.

; 7. Next 11 bits (bits 16-26) are MaximumPacketLength field for the target

;    endpoint.

; 8. Next bit (bit 27) is ControlEndpoint bit, must be 1 for USB1 control

;    endpoints and 0 for all others.

; 9. Upper 4 bits (bits 28-31) are NakCountReload field.

;    Zero for USB1 endpoints, zero for periodic endpoints.

;    For control/bulk USB2 endpoints, the code sets it to 4,

;    which is rather arbitrary.

Flags                   dd      ?

; 1. Lower byte is S-mask, each bit corresponds to one microframe per frame;

;    bit is set <=> enable transactions in this microframe.

; 2. Next byte is C-mask, each bit corresponds to one microframe per frame;

;    bit is set <=> enable complete-split transactions in this microframe.

;    Meaningful only for USB1 endpoints.

; 3. Next 14 bits give address of the target device as hub:port, bits 16-22

;    are the USB address of the hub, bits 23-29 are the port number.

;    Meaningful only for USB1 endpoints.

; 4. Upper 2 bits define number of consequetive transactions per micro-frame

;    which host is allowed to permit for this endpoint.

;    For control/bulk endpoints, it must be 1.

;    For periodic endpoints, the value is taken from the endpoint descriptor.

HeadTD                  dd      ?

; The physical address of the first TD for this pipe.

; Lower 5 bits must be zero.

Overlay                 ehci_hardware_td        ?

; Working area for the current TD, if there is any.

; When TD is retired, it is written to that TD and Overlay is loaded

; from the new TD, if any.

BaseList                dd      ?

; Pointer to head of the corresponding pipe list.

ends

; This structure describes the static head of every list of pipes.

; The hardware requires 32-bytes alignment of this structure.

; All instances of this structure are located sequentially in ehci_controller,

; ehci_controller is page-aligned, so it is sufficient to make this structure

; 32-bytes aligned and verify that the first instance is 32-bytes aligned

; inside ehci_controller.

; The hardware also requires that 44h bytes (size of 64-bit Queue Head

; Descriptor) starting at the beginning of this structure must not cross page

; boundary. If not, most hardware still behaves correctly (in fact, the last

; dword can have any value and this structure is never written), but on some

; hardware some things just break in mysterious ways.

struct ehci_static_ep

; Hardware fields are the same as in ehci_pipe.

; Only NextQH and Overlay.Token are actually used.

; NB: some emulators ignore Token.Halted bit (probably assuming that it is set

; only when device fails and emulation never fails) and always follow

; [Alternate]NextTD when they see that OverlayToken.Active bit is zero;

; so it is important to also set [Alternate]NextTD to 1.

NextQH          dd      ?

Token           dd      ?

Flags           dd      ?

HeadTD          dd      ?

NextTD          dd      ?

AlternateNextTD dd      ?

OverlayToken    dd      ?

NextList        dd      ?

SoftwarePart    rd      sizeof.usb_static_ep/4

Bandwidths      rw      8

                dd      ?

ends

if sizeof.ehci_static_ep mod 32

.err ehci_static_ep must be 32-bytes aligned

end if

if ehci_static_ep.OverlayToken <> ehci_pipe.Overlay.Token

.err ehci_static_ep.OverlayToken misplaced

end if

; EHCI-specific part of controller data.

; * The structure includes two parts, the hardware part and the software part.

; * The hardware part consists of first 4096 bytes and corresponds to

;   the Periodic Frame List from the EHCI specification.

; * The hardware requires page-alignment of the hardware part, so

;   the entire descriptor must be page-aligned.

;   This structure is allocated with kernel_alloc (see usb_init_controller),

;   this gives page-aligned data.

; * The controller is described by both ehci_controller and usb_controller

;   structures, for each controller there is one ehci_controller and one

;   usb_controller structure. These structures are located sequentially

;   in the memory: beginning from some page start, there is ehci_controller

;   structure - this enforces hardware alignment requirements - and then

;   usb_controller structure.

; * The code keeps pointer to usb_controller structure. The ehci_controller

;   structure is addressed as [ptr + ehci_controller.field - sizeof.ehci_controller].

struct ehci_controller

; ------------------------------ hardware fields ------------------------------

FrameList               rd      1024

; Entry n corresponds to the head of the frame list to be executed in

; the frames n,n+1024,n+2048,n+3072,...

; The first bit of each entry is Terminate bit, 1 = the frame is empty.

; Bits 1-2 are Type field, one of EHCI_TYPE_* constants.

; Bits 3-4 must be zero.

; With masked 5 lower bits, the entry is a physical address of the first QH/TD

; to be executed.

; ------------------------------ software fields ------------------------------

; Every list has the static head, which is an always halted QH.

; The following fields are static heads, one per list:

; 32+16+8+4+2+1 = 63 for Periodic lists, 1 for Control list and 1 for Bulk list.

IntEDs                  ehci_static_ep

                        rb      62 * sizeof.ehci_static_ep

; Beware.

; Two following strings ensure that 44h bytes at any static head

; do not cross page boundary. Without that, the code "works on my machine"...

; but fails on some hardware in seemingly unrelated ways.

; One hardware TD (without any software fields) fit in the rest of the page.

ehci_controller.ControlDelta = 2000h - (ehci_controller.IntEDs + 63 * sizeof.ehci_static_ep)

StopQueueTD             ehci_hardware_td

; Used as AlternateNextTD for transfers when short packet is considered

; as an error; short packet must stop the queue in this case, not advance

; to the next transfer.

                        rb      ehci_controller.ControlDelta - sizeof.ehci_hardware_td

; Padding for page-alignment.

ControlED               ehci_static_ep

BulkED                  ehci_static_ep

MMIOBase1               dd      ?

; Virtual address of memory-mapped area with part 1 of EHCI registers EhciXxxReg.

MMIOBase2               dd      ?

; Pointer inside memory-mapped area MMIOBase1; points to part 2 of EHCI registers.

StructuralParams        dd      ?

; Copy of EhciStructParamsReg value.

CapabilityParams        dd      ?

; Copy of EhciCapParamsReg value.

DeferredActions         dd      ?

; Bitmask of events from EhciStatusReg which were observed by the IRQ handler

; and needs to be processed in the IRQ thread.

ends

if ehci_controller.IntEDs mod 32

.err Static endpoint descriptors must be 32-bytes aligned inside ehci_controller

end if

; Description of #HCI-specific data and functions for

; controller-independent code.

; Implements the structure usb_hardware_func from hccommon.inc for EHCI.

iglobal

align 4

ehci_hardware_func:

        dd      'EHCI'

        dd      sizeof.ehci_controller

        dd      ehci_init

        dd      ehci_process_deferred

        dd      ehci_set_device_address

        dd      ehci_get_device_address

        dd      ehci_port_disable

        dd      ehci_new_port.reset

        dd      ehci_set_endpoint_packet_size

        dd      ehci_alloc_pipe

        dd      ehci_free_pipe

        dd      ehci_init_pipe

        dd      ehci_unlink_pipe

        dd      ehci_alloc_td

        dd      ehci_free_td

        dd      ehci_alloc_transfer

        dd      ehci_insert_transfer

        dd      ehci_new_device

endg

; =============================================================================

; =================================== Code ====================================

; =============================================================================

; Controller-specific initialization function.

; Called from usb_init_controller. Initializes the hardware and

; EHCI-specific parts of software structures.

; eax = pointer to ehci_controller to be initialized

; [ebp-4] = pcidevice

proc ehci_init

; inherit some variables from the parent (usb_init_controller)

.devfn   equ ebp - 4

.bus     equ ebp - 3

; 1. Store pointer to ehci_controller for further use.

        push    eax

        mov     edi, eax

        mov     esi, eax

; 2. Initialize ehci_controller.FrameList.

; Note that FrameList is located in the beginning of ehci_controller,

; so esi and edi now point to ehci_controller.FrameList.

; First 32 entries of FrameList contain physical addresses

; of first 32 Periodic static heads, further entries duplicate these.

; See the description of structures for full info.

; 2a. Get physical address of first static head.

; Note that 1) it is located in the beginning of a page

; and 2) first 32 static heads fit in the same page,

; so one call to get_phys_addr without correction of lower 12 bits

; is sufficient.

if (ehci_controller.IntEDs / 0x1000) <> ((ehci_controller.IntEDs + 32 * sizeof.ehci_static_ep) / 0x1000)

.err assertion failed

end if

if (ehci_controller.IntEDs mod 0x1000) <> 0

.err assertion failed

end if

        add     eax, ehci_controller.IntEDs

        call    get_phys_addr

; 2b. Fill first 32 entries.

        inc     eax

        inc     eax     ; set Type to EHCI_TYPE_QH

        movi    ecx, 32

        mov     edx, ecx

@@:

        stosd

        add     eax, sizeof.ehci_static_ep

        loop    @b

; 2c. Fill the rest entries.

        mov     ecx, 1024 - 32

        rep movsd

; 3. Initialize static heads ehci_controller.*ED.

; Use the loop over groups: first group consists of first 32 Periodic

; descriptors, next group consists of next 16 Periodic descriptors,

; ..., last group consists of the last Periodic descriptor.

; 3a. Prepare for the loop.

; make esi point to the second group, other registers are already set.

        add     esi, 32*4 + 32*sizeof.ehci_static_ep

; 3b. Loop over groups. On every iteration:

; edx = size of group, edi = pointer to the current group,

; esi = pointer to the next group.

.init_static_eds:

; 3c. Get the size of next group.

        shr     edx, 1

; 3d. Exit the loop if there is no next group.

        jz      .init_static_eds_done

; 3e. Initialize the first half of the current group.

; Advance edi to the second half.

        push    esi

        call    ehci_init_static_ep_group

        pop     esi

; 3f. Initialize the second half of the current group

; with the same values.

; Advance edi to the next group, esi/eax to the next of the next group.

        call    ehci_init_static_ep_group

        jmp     .init_static_eds

.init_static_eds_done:

; 3g. Initialize the last static head.

        xor     esi, esi

        call    ehci_init_static_endpoint

; While we are here, initialize StopQueueTD.

if (ehci_controller.StopQueueTD <> ehci_controller.IntEDs + 63 * sizeof.ehci_static_ep)

.err assertion failed

end if

        inc     [edi+ehci_hardware_td.NextTD]   ; 0 -> 1

        inc     [edi+ehci_hardware_td.AlternateNextTD]  ; 0 -> 1

; leave other fields as zero, including Active bit

; 3i. Initialize the head of Control list.

        add     edi, ehci_controller.ControlDelta

        lea     esi, [edi+sizeof.ehci_static_ep]

        call    ehci_init_static_endpoint

        or      byte [edi-sizeof.ehci_static_ep+ehci_static_ep.Token+1], 80h

; 3j. Initialize the head of Bulk list.

        sub     esi, sizeof.ehci_static_ep

        call    ehci_init_static_endpoint

; 4. Create a virtual memory area to talk with the controller.

; 4a. Enable memory & bus master access.

        mov     ch, [.bus]

        mov     cl, 1

        mov     eax, ecx

        mov     bh, [.devfn]

        mov     bl, 4

        call    pci_read_reg

        or      al, 6

        xchg    eax, ecx

        call    pci_write_reg

; 4b. Read memory base address.

        mov     ah, [.bus]

        mov     al, 2

        mov     bl, 10h

        call    pci_read_reg

;       DEBUGF 1,'K : phys MMIO %x\n',eax

        and     al, not 0Fh

; 4c. Create mapping for physical memory. 200h bytes are always sufficient.

        stdcall map_io_mem, eax, 200h, PG_SW+PG_NOCACHE

        test    eax, eax

        jz      .fail

;       DEBUGF 1,'K : MMIO %x\n',eax

if ehci_controller.MMIOBase1 <> ehci_controller.BulkED + sizeof.ehci_static_ep

.err assertion failed

end if

        stosd   ; fill ehci_controller.MMIOBase1

        movzx   ecx, byte [eax+EhciCapLengthReg]

        mov     edx, [eax+EhciCapParamsReg]

        mov     ebx, [eax+EhciStructParamsReg]

        add     eax, ecx

if ehci_controller.MMIOBase2 <> ehci_controller.MMIOBase1 + 4

.err assertion failed

end if

        stosd   ; fill ehci_controller.MMIOBase2

if ehci_controller.StructuralParams <> ehci_controller.MMIOBase2 + 4

.err assertion failed

end if

if ehci_controller.CapabilityParams <> ehci_controller.StructuralParams + 4

.err assertion failed

end if

        mov     [edi], ebx      ; fill ehci_controller.StructuralParams

        mov     [edi+4], edx    ; fill ehci_controller.CapabilityParams

        DEBUGF 1,'K : HCSPARAMS=%x, HCCPARAMS=%x\n',ebx,edx

        and     ebx, 15

        mov     [edi+usb_controller.NumPorts+sizeof.ehci_controller-ehci_controller.StructuralParams], ebx

        mov     edi, eax

; now edi = MMIOBase2

; 6. Transfer the controller to a known state.

; 6b. Stop the controller if it is running.

        movi    ecx, 10

        test    dword [edi+EhciStatusReg], 1 shl 12

        jnz     .stopped

        and     dword [edi+EhciCommandReg], not 1

@@:

        movi    esi, 1

        call    delay_ms

        test    dword [edi+EhciStatusReg], 1 shl 12

        jnz     .stopped

        loop    @b

        dbgstr 'Failed to stop EHCI controller'

        jmp     .fail_unmap

.stopped:

; 6c. Reset the controller. Wait up to 50 ms checking status every 1 ms.

        or      dword [edi+EhciCommandReg], 2

        movi    ecx, 50

@@:

        movi    esi, 1

        call    delay_ms

        test    dword [edi+EhciCommandReg], 2

        jz      .reset_ok

        loop    @b

        dbgstr 'Failed to reset EHCI controller'

        jmp     .fail_unmap

.reset_ok:

; 7. Configure the controller.

        pop     esi     ; restore the pointer saved at step 1

        add     esi, sizeof.ehci_controller

; 7a. If the controller is 64-bit, say to it that all structures are located

; in first 4G.

        test    byte [esi+ehci_controller.CapabilityParams-sizeof.ehci_controller], 1

        jz      @f

        mov     dword [edi+EhciCtrlDataSegReg], 0

@@:

; 7b. Hook interrupt and enable appropriate interrupt sources.

        mov     ah, [.bus]

        mov     al, 0

        mov     bh, [.devfn]

        mov     bl, 3Ch

        call    pci_read_reg

; al = IRQ

        DEBUGF 1,'K : attaching to IRQ %x\n',al

        movzx   eax, al

        stdcall attach_int_handler, eax, ehci_irq, esi

;       mov     dword [edi+EhciStatusReg], 111111b      ; clear status

; disable Frame List Rollover interrupt, enable all other sources

        mov     dword [edi+EhciInterruptReg], 110111b

; 7c. Inform the controller of the address of periodic lists head.

        lea     eax, [esi-sizeof.ehci_controller]

        call    get_phys_addr

        mov     dword [edi+EhciPeriodicListReg], eax

; 7d. Inform the controller of the address of asynchronous lists head.

        lea     eax, [esi+ehci_controller.ControlED-sizeof.ehci_controller]

        call    get_phys_addr

        mov     dword [edi+EhciAsyncListReg], eax

; 7e. Configure operational details and run the controller.

        mov     dword [edi+EhciCommandReg], \

                (1 shl 16) + \ ; interrupt threshold = 1 microframe = 0.125ms

                (0 shl 11) + \ ; disable Async Park Mode

                (0 shl 8) +  \ ; zero Async Park Mode Count

                (1 shl 5) +  \ ; Async Schedule Enable

                (1 shl 4) +  \ ; Periodic Schedule Enable

                (0 shl 2) +  \ ; 1024 elements in FrameList

                1              ; Run

; 7f. Route all ports to this controller, not companion controllers.

        mov     dword [edi+EhciConfigFlagReg], 1

        DEBUGF 1,'K : EHCI controller at %x:%x with %d ports initialized\n',[.bus]:2,[.devfn]:2,[esi+usb_controller.NumPorts]

; 8. Apply port power, if needed, and disable all ports.

        xor     ecx, ecx

@@:

        mov     dword [edi+EhciPortsReg+ecx*4], 1000h   ; Port Power enabled, all other bits disabled

        inc     ecx

        cmp     ecx, [esi+usb_controller.NumPorts]

        jb      @b

        test    byte [esi+ehci_controller.StructuralParams-sizeof.ehci_controller], 10h

        jz      @f

        push    esi

        movi    esi, 20

        call    delay_ms

        pop     esi

@@:

; 9. Return pointer to usb_controller.

        xchg    eax, esi

        ret

; On error, pop the pointer saved at step 1 and return zero.

; Note that the main code branch restores the stack at step 7 and never fails

; after step 7.

.fail_unmap:

        pop     eax

        push    eax

        stdcall free_kernel_space, [eax+ehci_controller.MMIOBase1]

.fail:

        pop     ecx

        xor     eax, eax

        ret

endp

; Helper procedure for step 3 of ehci_init, see comments there.

; Initializes the static head of one list.

; esi = pointer to the "next" list, edi = pointer to head to initialize.

; Advances edi to the next head, keeps esi.

proc ehci_init_static_endpoint

        xor     eax, eax

        inc     eax     ; set Terminate bit

        mov     [edi+ehci_static_ep.NextTD], eax

        mov     [edi+ehci_static_ep.AlternateNextTD], eax

        test    esi, esi

        jz      @f

        mov     eax, esi

        call    get_phys_addr

        inc     eax

        inc     eax     ; set Type to EHCI_TYPE_QH

@@:

        mov     [edi+ehci_static_ep.NextQH], eax

        mov     [edi+ehci_static_ep.NextList], esi

        mov     byte [edi+ehci_static_ep.OverlayToken], 1 shl 6 ; halted

        add     edi, ehci_static_ep.SoftwarePart

        call    usb_init_static_endpoint

        add     edi, sizeof.ehci_static_ep - ehci_static_ep.SoftwarePart

        ret

endp

; Helper procedure for step 3 of ehci_init, see comments there.

; Initializes one half of group of static heads.

; edx = size of the next group = half of size of the group,

; edi = pointer to the group, esi = pointer to the next group.

; Advances esi, edi to next group, keeps edx.

proc ehci_init_static_ep_group

        push    edx

@@:

        call    ehci_init_static_endpoint

        add     esi, sizeof.ehci_static_ep

        dec     edx

        jnz     @b

        pop     edx

        ret

endp

; Controller-specific pre-initialization function: take ownership from BIOS.

; Some BIOSes, although not all of them, use USB controllers themselves

; to support USB flash drives. In this case,

; we must notify the BIOS that we don't need that emulation and know how to

; deal with USB devices.

proc ehci_kickoff_bios

; 1. Get the physical address of MMIO registers.

        mov     ah, [esi+PCIDEV.bus]

        mov     bh, [esi+PCIDEV.devfn]

        mov     al, 2

        mov     bl, 10h

        call    pci_read_reg

        and     al, not 0Fh

; 2. Create mapping for physical memory. 200h bytes are always sufficient.

        stdcall map_io_mem, eax, 200h, PG_SW+PG_NOCACHE

        test    eax, eax

        jz      .nothing

        push    eax     ; push argument for step 8

; 3. Some BIOSes enable controller interrupts as a result of giving

; controller away. At this point the system knows nothing about how to serve

; EHCI interrupts, so such an interrupt will send the system into an infinite

; loop handling the same IRQ again and again. Thus, we need to block EHCI

; interrupts. We can't do this at the controller level until step 5,

; because the controller is currently owned by BIOS, so we block all hardware

; interrupts on this processor until step 5.

        pushf

        cli

; 4. Take the ownership over the controller.

; 4a. Locate take-ownership capability in the PCI configuration space.

; Limit the loop with 100h iterations; since the entire configuration space is

; 100h bytes long, hitting this number of iterations means that something is

; corrupted.

; Use a value from MMIO as a starting point.

        mov     edx, [eax+EhciCapParamsReg]

        movzx   edi, byte [eax+EhciCapLengthReg]

        add     edi, eax

        push    0

        mov     bl, dh          ; get Extended Capabilities Pointer

        test    bl, bl

        jz      .has_ownership2

        cmp     bl, 40h

        jb      .no_capability

.look_bios_handoff:

        test    bl, 3

        jnz     .no_capability

; In each iteration, read the current dword,

        mov     ah, [esi+PCIDEV.bus]

        mov     al, 2

        mov     bh, [esi+PCIDEV.devfn]

        call    pci_read_reg

; check, whether the capability ID is take-ownership ID = 1,

        cmp     al, 1

        jz      .found_bios_handoff

; if not, advance to next-capability link and continue loop.

        dec     byte [esp]

        jz      .no_capability

        mov     bl, ah

        cmp     bl, 40h

        jae     .look_bios_handoff

.no_capability:

        dbgstr 'warning: cannot locate take-ownership capability'

        jmp     .has_ownership2

.found_bios_handoff:

; 4b. Check whether BIOS has ownership.

; Some BIOSes release ownership before loading OS, but forget to unwatch for

; change-ownership requests; they cannot handle ownership request, so

; such a request sends the system into infinite loop of handling the same SMI

; over and over. Avoid this.

        inc     ebx

        inc     ebx

        test    eax, 0x10000

        jz      .has_ownership

; 4c. Request ownership.

        inc     ebx

        mov     cl, 1

        mov     ah, [esi+PCIDEV.bus]

        mov     al, 0

        call    pci_write_reg

; 4d. Some BIOSes set ownership flag, but forget to watch for change-ownership

; requests; if so, there is no sense in waiting.

        inc     ebx

        mov     ah, [esi+PCIDEV.bus]

        mov     al, 2

        call    pci_read_reg

        dec     ebx

        dec     ebx

        test    ah, 20h

        jz      .force_ownership

; 4e. Wait for result no more than 1 s, checking for status every 1 ms.

; If successful, go to 5.

        mov     dword [esp], 1000

@@:

        mov     ah, [esi+PCIDEV.bus]

        mov     al, 0

        call    pci_read_reg

        test    al, 1

        jz      .has_ownership

        push    esi

        movi    esi, 1

        call    delay_ms

        pop     esi

        dec     dword [esp]

        jnz     @b

        dbgstr  'warning: taking EHCI ownership from BIOS timeout'

.force_ownership:

; 4f. BIOS has not responded within the timeout.

; Let's just clear BIOS ownership flag and hope that everything will be ok.

        mov     ah, [esi+PCIDEV.bus]

        mov     al, 0

        mov     cl, 0

        call    pci_write_reg

.has_ownership:

; 5. Just in case clear all SMI event sources except change-ownership.

        dbgstr 'has_ownership'

        inc     ebx

        inc     ebx

        mov     ah, [esi+PCIDEV.bus]

        mov     al, 2

        mov     ecx, eax

        call    pci_read_reg

        and     ax, 2000h

        xchg    eax, ecx

        call    pci_write_reg

.has_ownership2:

        pop     ecx

; 6. Disable all controller interrupts until the system will be ready to

; process them.

        mov     dword [edi+EhciInterruptReg], 0

; 7. Now we can unblock interrupts in the processor.

        popf

; 8. Release memory mapping created in step 2 and return.

        call    free_kernel_space

.nothing:

        ret

endp

; IRQ handler for EHCI controllers.

ehci_irq.noint:

        spin_unlock_irqrestore [esi+usb_controller.WaitSpinlock]

; Not our interrupt: restore registers and return zero.

        xor     eax, eax

        pop     edi esi ebx

        ret

proc ehci_irq

        push    ebx esi edi     ; save registers to be cdecl

virtual at esp

        rd      3       ; saved registers

        dd      ?       ; return address

.controller     dd      ?

end virtual

; 1. ebx will hold whether some deferred processing is needed,

; that cannot be done from the interrupt handler. Initialize to zero.

        xor     ebx, ebx

; 2. Get the mask of events which should be processed.

        mov     esi, [.controller]

        mov     edi, [esi+ehci_controller.MMIOBase2-sizeof.ehci_controller]

        spin_lock_irqsave [esi+usb_controller.WaitSpinlock]

        mov     eax, [edi+EhciStatusReg]

;       DEBUGF 1,'K : [%d] EHCI status %x\n',[timer_ticks],eax

; 3. Check whether that interrupt has been generated by our controller.

; (One IRQ can be shared by several devices.)

        and     eax, [edi+EhciInterruptReg]

        jz      .noint

; 4. Clear the events we know of.

; Note that this should be done before processing of events:

; new events could arise while we are processing those, this way we won't lose

; them (the controller would generate another interrupt after completion

; of this one).

;       DEBUGF 1,'K : EHCI interrupt: status = %x\n',eax

        mov     [edi+EhciStatusReg], eax

; 5. Sanity check.

        test    al, 10h

        jz      @f

        DEBUGF 1,'K : something terrible happened with EHCI %x (%x)\n',esi,al

@@:

; We can't do too much from an interrupt handler. Inform the processing thread

; that it should perform appropriate actions.

        or      [esi+ehci_controller.DeferredActions-sizeof.ehci_controller], eax

        spin_unlock_irqrestore [esi+usb_controller.WaitSpinlock]

        inc     ebx

        call    usb_wakeup_if_needed

; 6. Interrupt processed; return non-zero.

        mov     al, 1

        pop     edi esi ebx     ; restore used registers to be cdecl

        ret

endp

; This procedure is called from usb_set_address_callback

; and stores USB device address in the ehci_pipe structure.

; in: esi -> usb_controller, ebx -> usb_pipe, cl = address

proc ehci_set_device_address

        mov     byte [ebx+ehci_pipe.Token-sizeof.ehci_pipe], cl

        call    usb_subscribe_control

        ret

endp

; This procedure returns USB device address from the ehci_pipe structure.

; in: esi -> usb_controller, ebx -> usb_pipe

; out: eax = endpoint address

proc ehci_get_device_address

        mov     eax, [ebx+ehci_pipe.Token-sizeof.ehci_pipe]

        and     eax, 7Fh

        ret

endp

; This procedure is called from usb_set_address_callback

; if the device does not accept SET_ADDRESS command and needs

; to be disabled at the port level.

; in: esi -> usb_controller, ecx = port (zero-based)

proc ehci_port_disable

        mov     eax, [esi+ehci_controller.MMIOBase2-sizeof.ehci_controller]

        and     dword [eax+EhciPortsReg+ecx*4], not (4 or 2Ah)

        ret

endp

; This procedure is called from usb_get_descr8_callback when

; the packet size for zero endpoint becomes known and

; stores the packet size in ehci_pipe structure.

; in: esi -> usb_controller, ebx -> usb_pipe, ecx = packet size

proc ehci_set_endpoint_packet_size

        mov     eax, [ebx+ehci_pipe.Token-sizeof.ehci_pipe]

        and     eax, not (0x7FF shl 16)

        shl     ecx, 16

        or      eax, ecx

        mov     [ebx+ehci_pipe.Token-sizeof.ehci_pipe], eax

; Wait until hardware cache is evicted.

        call    usb_subscribe_control

        ret

endp

uglobal

align 4

; Data for memory allocator, see memory.inc.

ehci_ep_first_page      dd      ?

ehci_ep_mutex           MUTEX

ehci_gtd_first_page     dd      ?

ehci_gtd_mutex          MUTEX

endg

; This procedure allocates memory for pipe.

; Both hardware+software parts must be allocated, returns pointer to usb_pipe

; (software part).

proc ehci_alloc_pipe

        push    ebx

        mov     ebx, ehci_ep_mutex

        stdcall usb_allocate_common, (sizeof.ehci_pipe + sizeof.usb_pipe + 1Fh) and not 1Fh

        test    eax, eax

        jz      @f

        add     eax, sizeof.ehci_pipe

@@:

        pop     ebx

        ret

endp

; This procedure frees memory for pipe allocated by ehci_alloc_pipe.

; void stdcall with one argument = pointer to usb_pipe.

proc ehci_free_pipe

virtual at esp

        dd      ?       ; return address

.ptr    dd      ?

end virtual

        sub     [.ptr], sizeof.ehci_pipe

        jmp     usb_free_common

endp

; This procedure is called from API usb_open_pipe and processes

; the controller-specific part of this API. See docs.

; in: edi -> usb_pipe for target, ecx -> usb_pipe for config pipe,

; esi -> usb_controller, eax -> usb_gtd for the first TD,

; [ebp+12] = endpoint, [ebp+16] = maxpacket, [ebp+20] = type

proc ehci_init_pipe

virtual at ebp+8

.config_pipe    dd      ?

.endpoint       dd      ?

.maxpacket      dd      ?

.type           dd      ?

.interval       dd      ?

end virtual

; 1. Zero all fields in the hardware part.

        push    eax ecx

        sub     edi, sizeof.ehci_pipe

        xor     eax, eax

        movi    ecx, sizeof.ehci_pipe/4

        rep stosd

        pop     ecx eax

; 2. Setup PID in the first TD and make sure that the it is not active.

        xor     edx, edx

        test    byte [.endpoint], 80h

        setnz   dh

        mov     [eax+ehci_gtd.Token-sizeof.ehci_gtd], edx

        mov     [eax+ehci_gtd.NextTD-sizeof.ehci_gtd], 1

        mov     [eax+ehci_gtd.AlternateNextTD-sizeof.ehci_gtd], 1

; 3. Store physical address of the first TD.

        sub     eax, sizeof.ehci_gtd

        call    get_phys_addr

        mov     [edi+ehci_pipe.Overlay.NextTD-sizeof.ehci_pipe], eax

; 4. Fill ehci_pipe.Flags except for S- and C-masks.

; Copy location from the config pipe.

        mov     eax, [ecx+ehci_pipe.Flags-sizeof.ehci_pipe]

        and     eax, 3FFF0000h

; Use 1 requests per microframe for control/bulk endpoints,

; use value from the endpoint descriptor for periodic endpoints

        movi    edx, 1

        test    [.type], 1

        jz      @f

        mov     edx, [.maxpacket]

        shr     edx, 11

        inc     edx

@@:

        shl     edx, 30

        or      eax, edx

        mov     [edi+ehci_pipe.Flags-sizeof.ehci_pipe], eax

; 5. Fill ehci_pipe.Token.

        mov     eax, [ecx+ehci_pipe.Token-sizeof.ehci_pipe]

; copy following fields from the config pipe:

; DeviceAddress, EndpointSpeed, ControlEndpoint if new type is control

        mov     ecx, eax

        and     eax, 307Fh

        and     ecx, 8000000h

        or      ecx, 4000h

        mov     edx, [.endpoint]

        and     edx, 15

        shl     edx, 8

        or      eax, edx

        mov     edx, [.maxpacket]

        shl     edx, 16

        or      eax, edx

; for control endpoints, use DataToggle from TD, otherwise use DataToggle from QH

        cmp     [.type], CONTROL_PIPE

        jnz     @f

        or      eax, ecx

@@:

; for control/bulk USB2 endpoints, set NakCountReload to 4

        test    eax, USB_SPEED_HS shl 12

        jz      .nonak

        cmp     [.type], CONTROL_PIPE

        jz      @f

        cmp     [.type], BULK_PIPE

        jnz     .nonak

@@:

        or      eax, 40000000h

.nonak:

        mov     [edi+ehci_pipe.Token-sizeof.ehci_pipe], eax

; 5. Select the corresponding list and insert to the list.

; 5a. Use Control list for control pipes, Bulk list for bulk pipes.

        lea     edx, [esi+ehci_controller.ControlED.SoftwarePart-sizeof.ehci_controller]

        cmp     [.type], BULK_PIPE

        jb      .insert ; control pipe

        lea     edx, [esi+ehci_controller.BulkED.SoftwarePart-sizeof.ehci_controller]

        jz      .insert ; bulk pipe

.interrupt_pipe:

; 5b. For interrupt pipes, let the scheduler select the appropriate list

; and the appropriate microframe(s) (which goes to S-mask and C-mask)

; based on the current bandwidth distribution and the requested bandwidth.

; There are two schedulers, one for high-speed devices,

; another for split transactions.

; This could fail if the requested bandwidth is not available;

; if so, return an error.

        test    word [edi+ehci_pipe.Flags-sizeof.ehci_pipe+2], 3FFFh

        jnz     .interrupt_tt

        call    ehci_select_hs_interrupt_list

        jmp     .interrupt_common

.interrupt_tt:

        call    ehci_select_tt_interrupt_list

.interrupt_common:

        test    edx, edx

        jz      .return0

        mov     word [edi+ehci_pipe.Flags-sizeof.ehci_pipe], ax

.insert:

        mov     [edi+ehci_pipe.BaseList-sizeof.ehci_pipe], edx

; Insert to the head of the corresponding list.

; Note: inserting to the head guarantees that the list traverse in

; ehci_process_updated_schedule, once started, will not interact with new pipes.

; However, we still need to ensure that links in the new pipe (edi.NextVirt)

; are initialized before links to the new pipe (edx.NextVirt).

; 5c. Insert in the list of virtual addresses.

        mov     ecx, [edx+usb_pipe.NextVirt]

        mov     [edi+usb_pipe.NextVirt], ecx

        mov     [edi+usb_pipe.PrevVirt], edx

        mov     [ecx+usb_pipe.PrevVirt], edi

        mov     [edx+usb_pipe.NextVirt], edi

; 5d. Insert in the hardware list: copy previous NextQH to the new pipe,

; store the physical address of the new pipe to previous NextQH.

        mov     ecx, [edx+ehci_static_ep.NextQH-ehci_static_ep.SoftwarePart]

        mov     [edi+ehci_pipe.NextQH-sizeof.ehci_pipe], ecx

        lea     eax, [edi-sizeof.ehci_pipe]

        call    get_phys_addr

        inc     eax

        inc     eax

        mov     [edx+ehci_static_ep.NextQH-ehci_static_ep.SoftwarePart], eax

; 6. Return with nonzero eax.

        ret

.return0:

        xor     eax, eax

        ret

endp

; This function is called from ehci_process_deferred when

; a new device was connected at least USB_CONNECT_DELAY ticks

; and therefore is ready to be configured.

; ecx = port, esi -> ehci_controller, edi -> EHCI MMIO

proc ehci_new_port

; 1. If the device operates at low-speed, just release it to a companion.

        mov     eax, [edi+EhciPortsReg+ecx*4]

        DEBUGF 1,'K : [%d] EHCI %x port %d state is %x\n',[timer_ticks],esi,ecx,eax

        mov     edx, eax

        and     ah, 0Ch

        cmp     ah, 4

        jz      .low_speed

; 2. Devices operating at full-speed and high-speed must now have ah == 8.

; Some broken hardware asserts both D+ and D- even after initial decoupling;

; if so, stop initialization here, no sense in further actions.

        cmp     ah, 0Ch

        jz      .se1

; 3. If another port is resetting right now, mark this port as 'reset pending'

; and return.

        bts     [esi+usb_controller.PendingPorts], ecx

        cmp     [esi+usb_controller.ResettingPort], -1

        jnz     .nothing

        btr     [esi+usb_controller.PendingPorts], ecx

; Otherwise, fall through to ohci_new_port.reset.

; This function is called from ehci_new_port and usb_test_pending_port.

; It starts reset signalling for the port. Note that in USB first stages

; of configuration can not be done for several ports in parallel.

.reset:

        push    edi

        mov     edi, [esi+ehci_controller.MMIOBase2-sizeof.ehci_controller]

        mov     eax, [edi+EhciPortsReg+ecx*4]

; 1. Store information about resetting hub (roothub) and port.

        and     [esi+usb_controller.ResettingHub], 0

        mov     [esi+usb_controller.ResettingPort], cl

; 2. Initiate reset signalling.

        or      ah, 1

        and     al, not (4 or 2Ah)

        mov     [edi+EhciPortsReg+ecx*4], eax

; 3. Store the current time and set status to 1 = reset signalling active.

        mov     eax, [timer_ticks]

        mov     [esi+usb_controller.ResetTime], eax

        mov     [esi+usb_controller.ResettingStatus], 1

;       dbgstr 'high-speed or full-speed device, resetting'

        DEBUGF 1,'K : [%d] EHCI %x: port %d has HS or FS device, resetting\n',[timer_ticks],esi,ecx

        pop     edi

.nothing:

        ret

.low_speed:

;       dbgstr 'low-speed device, releasing'

        DEBUGF 1,'K : [%d] EHCI %x: port %d has LS device, releasing\n',[timer_ticks],esi,ecx

        or      dh, 20h

        and     dl, not 2Ah

        mov     [edi+EhciPortsReg+ecx*4], edx

        ret

.se1:

        dbgstr 'SE1 after connect debounce. Broken hardware?'

        ret

endp

; This procedure is called from several places in main USB code

; and allocates required packets for the given transfer.

; ebx = pipe, other parameters are passed through the stack:

; buffer,size = data to transfer

; flags = same as in usb_open_pipe: bit 0 = allow short transfer, other bits reserved

; td = pointer to the current end-of-queue descriptor

; direction =

;   0000b for normal transfers,

;   1000b for control SETUP transfer,

;   1101b for control OUT transfer,

;   1110b for control IN transfer

; returns eax = pointer to the new end-of-queue descriptor

; (not included in the queue itself) or 0 on error

proc ehci_alloc_transfer stdcall uses edi, \

        buffer:dword, size:dword, flags:dword, td:dword, direction:dword

locals

origTD          dd      ?

packetSize      dd      ?       ; must be last variable, see usb_init_transfer

endl

; 1. Save original value of td:

; it will be useful for rollback if something would fail.

        mov     eax, [td]

        mov     [origTD], eax

; One transfer descriptor can describe up to 5 pages.

; In the worst case (when the buffer is something*1000h+0FFFh)

; this corresponds to 4001h bytes. If the requested size is

; greater, we should split the transfer into several descriptors.

; Boundaries to split must be multiples of endpoint transfer size

; to avoid short packets except in the end of the transfer.

        cmp     [size], 4001h

        jbe     .lastpacket

; 2. While the remaining data cannot fit in one descriptor,

; allocate full descriptors (of maximal possible size).

; 2a. Calculate size of one descriptor: must be a multiple of transfer size

; and must be not greater than 4001h.

        movzx   ecx, word [ebx+ohci_pipe.Flags+2-sizeof.ohci_pipe]

        mov     eax, 4001h

        xor     edx, edx

        mov     edi, eax

        div     ecx

        sub     edi, edx

        mov     [packetSize], edi

.fullpackets:

        call    ehci_alloc_packet

        test    eax, eax

        jz      .fail

        mov     [td], eax

        add     [buffer], edi

        sub     [size], edi

        cmp     [size], 4001h

        ja      .fullpackets

; 3. The remaining data can fit in one packet;

; allocate the last descriptor with size = size of remaining data.

.lastpacket:

        mov     eax, [size]

        mov     [packetSize], eax

        call    ehci_alloc_packet

        test    eax, eax

        jz      .fail

; 9. Update flags in the last packet.

        mov     edx, [flags]

        mov     [ecx+ehci_gtd.Flags-sizeof.ehci_gtd], edx

; 10. Fill AlternateNextTD field in all allocated TDs.

; If the caller says that short transfer is ok, the queue must advance to

; the next descriptor, which is in eax.

; Otherwise, the queue should stop, so make AlternateNextTD point to

; always-inactive descriptor StopQueueTD.

        push    eax

        test    dl, 1

        jz      .disable_short

        sub     eax, sizeof.ehci_gtd

        jmp     @f

.disable_short:

        mov     eax, [ebx+usb_pipe.Controller]

        add     eax, ehci_controller.StopQueueTD - sizeof.ehci_controller

@@:

        call    get_phys_addr

        mov     edx, [origTD]

@@:

        cmp     edx, [esp]

        jz      @f

        mov     [edx+ehci_gtd.AlternateNextTD-sizeof.ehci_gtd], eax

        mov     edx, [edx+usb_gtd.NextVirt]

        jmp     @b

@@:

        pop     eax

        ret

.fail:

        mov     edi, ehci_hardware_func

        mov     eax, [td]

        stdcall usb_undo_tds, [origTD]

        xor     eax, eax

        ret

endp

; Helper procedure for ehci_alloc_transfer.

; Allocates and initializes one transfer descriptor.

; ebx = pipe, other parameters are passed through the stack;

; fills the current last descriptor and

; returns eax = next descriptor (not filled).