Subversion Repositories Kolibri OS

; OHCI-specific part of a pipe descriptor.

; OHCI-specific part of a pipe descriptor.

; * This structure corresponds to the Endpoint Descriptor aka ED from the OHCI

; * This structure corresponds to the Endpoint Descriptor aka ED from the OHCI

;   specification.

;   specification.

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

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

;   Since the allocator (usb_allocate_common) allocates memory sequentially

;   Since the allocator (usb_allocate_common) allocates memory sequentially

struct ohci_pipe

struct ohci_pipe

; All addresses are physical.

; All addresses are physical.

Flags           dd      ?

Flags           dd      ?

; 1. Lower 7 bits (bits 0-6) are FunctionAddress. This is the USB address of

; 1. Lower 7 bits (bits 0-6) are FunctionAddress. This is the USB address of

;    the function containing the endpoint that this ED controls.

;    the function containing the endpoint that this ED controls.

; * The 1ms periodic list also serves Isochronous endpoints, which should be

; * The 1ms periodic list also serves Isochronous endpoints, which should be

;   in the end of the list.

;   in the end of the list.

; * There is no "next" list for Bulk and Control lists, they are processed

; * There is no "next" list for Bulk and Control lists, they are processed

;   separately from others.

;   separately from others.

; * There is no "next" list for Periodic list for 1ms interval.

; * There is no "next" list for Periodic list for 1ms interval.

ends

ends

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

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

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

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

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

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

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

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

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

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

;   the General Transfer Descriptor aka general TD from OHCI specification.

;   the General Transfer Descriptor aka general TD from OHCI specification.

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

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

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

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

;   (usb_allocate_common) allocates memory sequentially from page start

;   (usb_allocate_common) allocates memory sequentially from page start

struct ohci_gtd

struct ohci_gtd

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

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

; All addresses in this part are physical.

; All addresses in this part are physical.

Flags           dd      ?

Flags           dd      ?

; 1. Lower 18 bits (bits 0-17) are ignored and not modified by the hardware.

; 1. Lower 18 bits (bits 0-17) are ignored and not modified by the hardware.

;   Physical address of the previous processed TD.

;   Physical address of the previous processed TD.

; When the descriptor is processed by the IRQ handler, but not yet completed:

; When the descriptor is processed by the IRQ handler, but not yet completed:

;   Virtual pointer to the next processed TD.

;   Virtual pointer to the next processed TD.

BufEnd          dd      ?

BufEnd          dd      ?

; Physical address of the last byte in the buffer for this TD.

; Physical address of the last byte in the buffer for this TD.

ends

ends

; OHCI isochronous transfer descriptor.

; OHCI isochronous transfer descriptor.

; * The structure describes transfers to be performed on Isochronous endpoints.

; * The structure describes transfers to be performed on Isochronous endpoints.

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

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

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

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

; edx = virtual pointer to the last item.NextTD (first in the reverse list)

; edx = virtual pointer to the last item.NextTD (first in the reverse list)

; ebx = virtual pointer to the next item (previous in the reverse list)

; ebx = virtual pointer to the next item (previous in the reverse list)

.tdloop:

.tdloop:

        mov     ecx, [eax+ohci_gtd.NextTD]

        mov     ecx, [eax+ohci_gtd.NextTD]

        mov     [eax+ohci_gtd.NextTD], ebx

        mov     [eax+ohci_gtd.NextTD], ebx

        test    ecx, ecx

        test    ecx, ecx

        jz      .tddone

        jz      .tddone

        call    usb_td_to_virt

        call    usb_td_to_virt

        test    eax, eax

        test    eax, eax

        jnz     .tdloop

        jnz     .tdloop

; This procedure is called from usb_set_address_callback

; This procedure is called from usb_set_address_callback

; and stores USB device address in the ohci_pipe structure.

; and stores USB device address in the ohci_pipe structure.

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

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

        mov     byte [ebx+ohci_pipe.Flags-ohci_pipe.SoftwarePart], cl

        mov     byte [ebx+ohci_pipe.Flags-sizeof.ohci_pipe], cl

; Wait until the hardware will forget the old value.

; Wait until the hardware will forget the old value.

        call    usb_subscribe_control

        call    usb_subscribe_control

        ret

        ret

endp

endp

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

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

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

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

proc ohci_get_device_address

proc ohci_get_device_address

        mov     eax, [ebx+ohci_pipe.Flags-ohci_pipe.SoftwarePart]

        mov     eax, [ebx+ohci_pipe.Flags-sizeof.ohci_pipe]

        and     eax, 7Fh

        and     eax, 7Fh

        ret

        ret

; This procedure is called from usb_get_descr8_callback when

; This procedure is called from usb_get_descr8_callback when

; the packet size for zero endpoint becomes known and

; the packet size for zero endpoint becomes known and

; stores the packet size in ohci_pipe structure.

; stores the packet size in ohci_pipe structure.

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

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

proc ohci_set_endpoint_packet_size

proc ohci_set_endpoint_packet_size

; Wait until the hardware will forget the old value.

; Wait until the hardware will forget the old value.

        call    usb_subscribe_control

        call    usb_subscribe_control

        ret

        ret

endp

endp

.maxpacket      dd      ?

.maxpacket      dd      ?

.type           dd      ?

.type           dd      ?

.interval       dd      ?

.interval       dd      ?

end virtual

end virtual

; 1. Initialize the queue of transfer descriptors: empty.

; 1. Initialize the queue of transfer descriptors: empty.

        call    get_phys_addr

        call    get_phys_addr

; 2. Generate ohci_pipe.Flags, see the description in ohci_pipe.

; 2. Generate ohci_pipe.Flags, see the description in ohci_pipe.

        and     eax, 0x207F     ; keep Speed bit and FunctionAddress

        and     eax, 0x207F     ; keep Speed bit and FunctionAddress

        mov     edx, [.endpoint]

        mov     edx, [.endpoint]

        and     edx, 15

        and     edx, 15

        shl     edx, 7

        shl     edx, 7

        or      eax, edx

        or      eax, edx

        mov     eax, [.maxpacket]

        mov     eax, [.maxpacket]

        cmp     [.type], CONTROL_PIPE

        cmp     [.type], CONTROL_PIPE

        jz      @f

        jz      @f

        test    byte [.endpoint], 80h

        test    byte [.endpoint], 80h

        setnz   al

        setnz   al

        inc     eax

        inc     eax

        shl     al, 3

        shl     al, 3

@@:

@@:

; 3. Insert the new pipe to the corresponding list of endpoints.

; 3. Insert the new pipe to the corresponding list of endpoints.

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

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

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

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

        cmp     [.type], BULK_PIPE

        cmp     [.type], BULK_PIPE

        mov     ecx, [edx+usb_pipe.NextVirt]

        mov     ecx, [edx+usb_pipe.NextVirt]

        mov     [edi+usb_pipe.NextVirt], ecx

        mov     [edi+usb_pipe.NextVirt], ecx

        mov     [edi+usb_pipe.PrevVirt], edx

        mov     [edi+usb_pipe.PrevVirt], edx

        mov     [ecx+usb_pipe.PrevVirt], edi

        mov     [ecx+usb_pipe.PrevVirt], edi

        mov     [edx+usb_pipe.NextVirt], edi

        mov     [edx+usb_pipe.NextVirt], edi

        call    get_phys_addr

        call    get_phys_addr

; 4. Return something non-zero.

; 4. Return something non-zero.

        ret

        ret

.return0:

.return0:

        xor     eax, eax

        xor     eax, eax

        ret

        ret

        mov     [packetSize], eax

        mov     [packetSize], eax

        call    ohci_alloc_packet

        call    ohci_alloc_packet

        test    eax, eax

        test    eax, eax

        jz      .fail

        jz      .fail

; 4. Enable an immediate interrupt on completion of the last packet.

; 4. Enable an immediate interrupt on completion of the last packet.

; 5. If a short transfer is ok for a caller, set the corresponding bit in

; 5. If a short transfer is ok for a caller, set the corresponding bit in

; the last descriptor, but not in others.

; the last descriptor, but not in others.

; Note: even if the caller says that short transfers are ok,

; Note: even if the caller says that short transfers are ok,

; all packets except the last one are marked as 'must be complete':

; all packets except the last one are marked as 'must be complete':

; if one of them will be short, the software intervention is needed

; if one of them will be short, the software intervention is needed

; to skip remaining packets; ohci_process_finalized_td will handle this

; to skip remaining packets; ohci_process_finalized_td will handle this

; transparently to the caller.

; transparently to the caller.

        test    [flags], 1

        test    [flags], 1

        jz      @f

        jz      @f

@@:

@@:

        ret

        ret

.fail:

.fail:

        mov     edi, ohci_hardware_func

        mov     edi, ohci_hardware_func

        mov     eax, [td]

        mov     eax, [td]

        call    usb_init_transfer

        call    usb_init_transfer

        pop     eax

        pop     eax

; 3. Save the returned value (next descriptor).

; 3. Save the returned value (next descriptor).

        push    eax

        push    eax

; 4. Store the physical address of the next descriptor.

; 4. Store the physical address of the next descriptor.

        call    get_phys_addr

        call    get_phys_addr

; 5. For zero-length transfers, store zero in both fields for buffer addresses.

; 5. For zero-length transfers, store zero in both fields for buffer addresses.

; Otherwise, fill them with real values.

; Otherwise, fill them with real values.

        xor     eax, eax

        xor     eax, eax

        cmp     [.packetSize], eax

        cmp     [.packetSize], eax

        jz      @f

        jz      @f

        mov     eax, [.buffer]

        mov     eax, [.buffer]

        call    get_phys_addr

        call    get_phys_addr

        mov     eax, [.buffer]

        mov     eax, [.buffer]

        add     eax, [.packetSize]

        add     eax, [.packetSize]

        dec     eax

        dec     eax

        call    get_phys_addr

        call    get_phys_addr

@@:

@@:

; 6. Generate Flags field:

; 6. Generate Flags field:

; - set bufferRounding (bit 18) to zero = disallow short transfers;

; - set bufferRounding (bit 18) to zero = disallow short transfers;

;   for the last transfer in a row, ohci_alloc_transfer would set the real value;

;   for the last transfer in a row, ohci_alloc_transfer would set the real value;

; - set Direction (bits 19-20) to lower 2 bits of [.direction];

; - set Direction (bits 19-20) to lower 2 bits of [.direction];

        and     eax, 3

        and     eax, 3

        shl     eax, 19

        shl     eax, 19

        and     edx, (3 shl 2)

        and     edx, (3 shl 2)

        shl     edx, 24 - 2

        shl     edx, 24 - 2

        lea     eax, [eax + edx + (7 shl 21) + (15 shl 28)]

        lea     eax, [eax + edx + (7 shl 21) + (15 shl 28)]

; 7. Restore the returned value saved in step 3.

; 7. Restore the returned value saved in step 3.

        pop     eax

        pop     eax

.nothing:

.nothing:

        ret

        ret

endp

endp

; and activates the transfer which was previously allocated by

; and activates the transfer which was previously allocated by

; ohci_alloc_transfer.

; ohci_alloc_transfer.

; ecx -> last descriptor for the transfer, ebx -> usb_pipe

; ecx -> last descriptor for the transfer, ebx -> usb_pipe

proc ohci_insert_transfer

proc ohci_insert_transfer

; 1. Advance the queue of transfer descriptors.

; 1. Advance the queue of transfer descriptors.

; 2. For control and bulk pipes, notify the controller that

; 2. For control and bulk pipes, notify the controller that

; there is new work in control/bulk queue respectively.

; there is new work in control/bulk queue respectively.

ohci_notify_new_work:

ohci_notify_new_work:

        mov     edx, [ebx+usb_pipe.Controller]

        mov     edx, [ebx+usb_pipe.Controller]

        mov     edx, [edx+ohci_controller.MMIOBase-sizeof.ohci_controller]

        mov     edx, [edx+ohci_controller.MMIOBase-sizeof.ohci_controller]

; disconnect; if so, the callback will be called by usb_pipe_closed with

; disconnect; if so, the callback will be called by usb_pipe_closed with

; correct status, so go to step 6 with ebx = 0 (do not free the TD).

; correct status, so go to step 6 with ebx = 0 (do not free the TD).

        mov     edx, [ebx+usb_gtd.Pipe]

        mov     edx, [ebx+usb_gtd.Pipe]

        test    [edx+usb_pipe.Flags], USB_FLAG_CLOSED

        test    [edx+usb_pipe.Flags], USB_FLAG_CLOSED

        jz      @f

        jz      @f

        xor     ebx, ebx

        xor     ebx, ebx

        jmp     .next_td2

        jmp     .next_td2

@@:

@@:

; 2. Remove the descriptor from the descriptors queue.

; 2. Remove the descriptor from the descriptors queue.

        call    usb_unlink_td

        call    usb_unlink_td

; 3. Get number of bytes that remain to be transferred.

; 3. Get number of bytes that remain to be transferred.

; If CurBufPtr is zero, everything was transferred.

; If CurBufPtr is zero, everything was transferred.

        xor     edx, edx

        xor     edx, edx

        jz      .gotlen

        jz      .gotlen

; Otherwise, the remaining length is

; Otherwise, the remaining length is

; (BufEnd and 0xFFF) - (CurBufPtr and 0xFFF) + 1,

; (BufEnd and 0xFFF) - (CurBufPtr and 0xFFF) + 1,

; plus 0x1000 if BufEnd and CurBufPtr are in different pages.

; plus 0x1000 if BufEnd and CurBufPtr are in different pages.

        mov     ecx, edx

        mov     ecx, edx

        and     edx, 0xFFF

        and     edx, 0xFFF

        inc     edx

        inc     edx

        xor     ecx, eax

        xor     ecx, eax

        and     ecx, -0x1000

        and     ecx, -0x1000

; The actual length is Length - (remaining length).

; The actual length is Length - (remaining length).

        sub     edx, [ebx+usb_gtd.Length]

        sub     edx, [ebx+usb_gtd.Length]

        neg     edx

        neg     edx

; 4. Check for error. If so, go to 7.

; 4. Check for error. If so, go to 7.

        push    ebx

        push    ebx

        shr     eax, 28

        shr     eax, 28

        jnz     .error

        jnz     .error

.notify:

.notify:

; 5. Successful completion.

; 5. Successful completion.

; 5a. Check whether this descriptor has an associated callback.

; 5a. Check whether this descriptor has an associated callback.

        cmp     ebx, [esp]

        cmp     ebx, [esp]

        jz      @f

        jz      @f

        stdcall usb1_free_general_td, ebx

        stdcall usb1_free_general_td, ebx

@@:

@@:

        pop     ebx

        pop     ebx

.next_td2:

.next_td2:

        push    ebx

        push    ebx

        mov     ebx, eax

        mov     ebx, eax

        lea     edx, [esi+ohci_controller.DoneList-sizeof.ohci_controller]

        lea     edx, [esi+ohci_controller.DoneList-sizeof.ohci_controller]

        xor     ecx, ecx        ; no next item

        xor     ecx, ecx        ; no next item

; The hardware has stopped processing the queue.

; The hardware has stopped processing the queue.

; 7a. Save status and length.

; 7a. Save status and length.

        push    eax

        push    eax

        push    edx

        push    edx

;       DEBUGF 1,'K : TD failed:\n'

;       DEBUGF 1,'K : TD failed:\n'

;       mov     eax, [ebx+usb_gtd.Pipe]

;       mov     eax, [ebx+usb_gtd.Pipe]

; 7b. Traverse the list of descriptors looking for the final packet

; 7b. Traverse the list of descriptors looking for the final packet

; for this transfer.

; for this transfer.

; Free and unlink non-final descriptors, except the current one.

; Free and unlink non-final descriptors, except the current one.

; Final descriptor will be freed in step 6.

; Final descriptor will be freed in step 6.

        call    usb_is_final_packet

        call    usb_is_final_packet

; as short-packet-is-error to stop controller from further processing

; as short-packet-is-error to stop controller from further processing

; of that stage; we need to restart processing from a TD following the last.

; of that stage; we need to restart processing from a TD following the last.

; After that, go to step 5 with eax = 0 (no error).

; After that, go to step 5 with eax = 0 (no error).

        cmp     dword [.error_code], USB_STATUS_UNDERRUN

        cmp     dword [.error_code], USB_STATUS_UNDERRUN

        jnz     .no_underrun

        jnz     .no_underrun

        jz      .no_underrun

        jz      .no_underrun

        and     dword [.error_code], 0

        and     dword [.error_code], 0

        mov     ecx, [ebx+usb_gtd.Pipe]

        mov     ecx, [ebx+usb_gtd.Pipe]

        and     edx, 2

        and     edx, 2

.advance_queue:

.advance_queue:

        mov     eax, [ebx+usb_gtd.NextVirt]

        mov     eax, [ebx+usb_gtd.NextVirt]

        call    get_phys_addr

        call    get_phys_addr

        or      eax, edx

        or      eax, edx

        push    ebx

        push    ebx

        mov     ebx, ecx

        mov     ebx, ecx

        call    ohci_notify_new_work

        call    ohci_notify_new_work

        pop     ebx

        pop     ebx

        pop     edx eax

        pop     edx eax

; of any control transfer), so we hope on the best and just advance the queue

; of any control transfer), so we hope on the best and just advance the queue

; to the next transfer. (According to the standard, "A control pipe may also

; to the next transfer. (According to the standard, "A control pipe may also

; support functional stall as well, but this is not recommended.").

; support functional stall as well, but this is not recommended.").

; Advance the transfer queue to the next descriptor.

; Advance the transfer queue to the next descriptor.

        mov     ecx, [ebx+usb_gtd.Pipe]

        mov     ecx, [ebx+usb_gtd.Pipe]

        and     edx, 2  ; keep toggleCarry bit

        and     edx, 2  ; keep toggleCarry bit

        cmp     [ecx+usb_pipe.Type], CONTROL_PIPE

        cmp     [ecx+usb_pipe.Type], CONTROL_PIPE

        jnz     @f

        jnz     @f

        inc     edx     ; set Halted bit

        inc     edx     ; set Halted bit

@@:

@@:

; or due to disconnect); it unlinks the pipe from the corresponding list.

; or due to disconnect); it unlinks the pipe from the corresponding list.

; esi -> usb_controller, ebx -> usb_pipe

; esi -> usb_controller, ebx -> usb_pipe

proc ohci_unlink_pipe

proc ohci_unlink_pipe

        cmp     [ebx+usb_pipe.Type], INTERRUPT_PIPE

        cmp     [ebx+usb_pipe.Type], INTERRUPT_PIPE

        jnz     @f

        jnz     @f

        bt      eax, 13

        bt      eax, 13

        setc    cl

        setc    cl

        bt      eax, 11

        bt      eax, 11

        setc    ch

        setc    ch

        shr     eax, 16

        shr     eax, 16

@@:

@@:

        mov     edx, [ebx+usb_pipe.NextVirt]

        mov     edx, [ebx+usb_pipe.NextVirt]

        mov     eax, [ebx+usb_pipe.PrevVirt]

        mov     eax, [ebx+usb_pipe.PrevVirt]

        mov     [edx+usb_pipe.PrevVirt], eax

        mov     [edx+usb_pipe.PrevVirt], eax

        mov     [eax+usb_pipe.NextVirt], edx

        mov     [eax+usb_pipe.NextVirt], edx

        ret

        ret

endp

endp