Subversion Repositories Kolibri OS

;   specification with some additional fields.

;   specification with some additional fields.

; * The hardware uses first two fields (8 bytes). Next two fields are used for

; * The hardware uses first two fields (8 bytes). Next two fields are used for

;   software book-keeping.

;   software book-keeping.

; * 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 uhci_pipe

struct uhci_pipe

NextQH          dd      ?

NextQH          dd      ?

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

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

; 2. Next bit (bit 1) is QH/TD select bit. 1 = NextQH points to QH.

; 2. Next bit (bit 1) is QH/TD select bit. 1 = NextQH points to QH.

; 3. Next two bits (bits 2-3) are reserved.

; 3. Next two bits (bits 2-3) are reserved.

; the MaximumLength bitfield encodes maximum packet size,

; the MaximumLength bitfield encodes maximum packet size,

; the Reserved bit 20 is LowSpeedDevice bit.

; the Reserved bit 20 is LowSpeedDevice bit.

ErrorTD         dd      ?

ErrorTD         dd      ?

; Usually NULL. If nonzero, it is a pointer to descriptor which was error'd

; Usually NULL. If nonzero, it is a pointer to descriptor which was error'd

; and should be freed sometime in the future (the hardware could still use it).

; and should be freed sometime in the future (the hardware could still use it).

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

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

;   Transfer Descriptor aka TD from UHCI specification.

;   Transfer Descriptor aka TD from UHCI 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

;   (uhci_allocate_common) allocates memory sequentially from page start

;   (uhci_allocate_common) allocates memory sequentially from page start

struct uhci_gtd

struct uhci_gtd

NextTD          dd      ?

NextTD          dd      ?

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

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

; 2. Next bit (bit 1) is QH/TD select bit. 1 = NextTD points to QH.

; 2. Next bit (bit 1) is QH/TD select bit. 1 = NextTD points to QH.

;    This bit is always set to 0 in the implementation.

;    This bit is always set to 0 in the implementation.

; Usually NULL. If the original buffer crosses a page boundary, this is a

; Usually NULL. If the original buffer crosses a page boundary, this is a

; pointer to the structure uhci_original_buffer for this request.

; pointer to the structure uhci_original_buffer for this request.

; bit 0: 1 = short packet is NOT allowed

; bit 0: 1 = short packet is NOT allowed

; (before the TD is processed, it is the copy of bit 29 of ControlStatus;

; (before the TD is processed, it is the copy of bit 29 of ControlStatus;

;  some controllers modify that bit, so we need a copy in a safe place)

;  some controllers modify that bit, so we need a copy in a safe place)

ends

ends

; UHCI requires that the entire transfer buffer should be on one page.

; UHCI requires that the entire transfer buffer should be on one page.

; If the actual buffer crosses page boundary, uhci_alloc_packet

; If the actual buffer crosses page boundary, uhci_alloc_packet

; allocates additional memory for buffer for hardware.

; allocates additional memory for buffer for hardware.

; This structure describes correspondence between two buffers.

; This structure describes correspondence between two buffers.

.tdloop:

.tdloop:

; 3. For every descriptor, test active flag and check for end-of-queue;

; 3. For every descriptor, test active flag and check for end-of-queue;

; if either of conditions holds, exit from the internal loop.

; if either of conditions holds, exit from the internal loop.

        cmp     ebx, [esp]

        cmp     ebx, [esp]

        jz      .tddone

        jz      .tddone

        test    eax, 1 shl 23   ; active?

        test    eax, 1 shl 23   ; active?

        jnz     .tddone

        jnz     .tddone

; Release the queue lock while processing one descriptor:

; Release the queue lock while processing one descriptor:

; callback function could (and often would) schedule another transfer.

; callback function could (and often would) schedule another transfer.

        push    ecx

        push    ecx

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

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

;       DEBUGF 1,'K : %x %x %x %x\n',[ebx-20],[ebx-16],[ebx-12],[ebx-8]

;       DEBUGF 1,'K : %x %x %x %x\n',[ebx-20],[ebx-16],[ebx-12],[ebx-8]

;       DEBUGF 1,'K : %x %x %x %x\n',[ebx-4],[ebx],[ebx+4],[ebx+8]

;       DEBUGF 1,'K : %x %x %x %x\n',[ebx-4],[ebx],[ebx+4],[ebx+8]

; 2. If this is IN transfer into special buffer, copy the data

; 2. If this is IN transfer into special buffer, copy the data

; to target location.

; to target location.

        and     edx, not 1      ; clear lsb (used for another goal)

        and     edx, not 1      ; clear lsb (used for another goal)

        jz      .nocopy

        jz      .nocopy

        jnz     .nocopy

        jnz     .nocopy

; Note: we assume that pointer to buffer is valid in the memory space of

; Note: we assume that pointer to buffer is valid in the memory space of

; the USB thread. This means that buffer must reside in kernel memory

; the USB thread. This means that buffer must reside in kernel memory

; (shared by all processes).

; (shared by all processes).

        push    esi edi

        push    esi edi

        mov     esi, [edx+uhci_original_buffer.UsedBuffer]

        mov     esi, [edx+uhci_original_buffer.UsedBuffer]

        mov     edi, [edx+uhci_original_buffer.OrigBuffer]

        mov     edi, [edx+uhci_original_buffer.OrigBuffer]

        inc     ecx

        inc     ecx

        and     ecx, 7FFh

        and     ecx, 7FFh

        mov     edx, ecx

        mov     edx, ecx

        shr     ecx, 2

        shr     ecx, 2

        and     edx, 3

        and     edx, 3

        rep movsb

        rep movsb

        pop     edi esi

        pop     edi esi

.nocopy:

.nocopy:

; 3. Calculate actual number of bytes transferred.

; 3. Calculate actual number of bytes transferred.

; 3a. Read the state.

; 3a. Read the state.

; 3b. Get number of bytes processed.

; 3b. Get number of bytes processed.

        lea     edx, [eax+1]

        lea     edx, [eax+1]

        and     edx, 7FFh

        and     edx, 7FFh

; 3c. Subtract number of bytes in this packet.

; 3c. Subtract number of bytes in this packet.

        add     ecx, 1 shl 21

        add     ecx, 1 shl 21

; because the caller disallowed short packets or because the packet is not

; because the caller disallowed short packets or because the packet is not

; the last one in the corresponding transfer).

; the last one in the corresponding transfer).

        xor     ecx, ecx

        xor     ecx, ecx

        test    eax, 1 shl 22

        test    eax, 1 shl 22

        jnz     .error

        jnz     .error

        jz      .notify

        jz      .notify

        cmp     edx, [ebx+usb_gtd.Length]

        cmp     edx, [ebx+usb_gtd.Length]

        jz      .notify

        jz      .notify

.error:

.error:

; 5. There was an error while processing this packet.

; 5. There was an error while processing this packet.

; The hardware has stopped processing the queue.

; The hardware has stopped processing the queue.

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

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

.err modify offsets for debug output

.err modify offsets for debug output

end if

end if

        DEBUGF 1,'K : %x %x %x %x\n',[ebx-20],[ebx-16],[ebx-12],[ebx-8]

        DEBUGF 1,'K : %x %x %x %x\n',[ebx-20],[ebx-16],[ebx-12],[ebx-8]

        DEBUGF 1,'K : %x %x %x %x\n',[ebx-4],[ebx],[ebx+4],[ebx+8]

        DEBUGF 1,'K : %x %x %x %x\n',[ebx-4],[ebx],[ebx+4],[ebx+8]

; 5a. Save the status and length.

; 5a. Save the status and length.

        push    edx

        push    edx

        push    eax

        push    eax

        mov     eax, [ebx+usb_gtd.Pipe]

        mov     eax, [ebx+usb_gtd.Pipe]

; 5b. Store the current TD as an error packet.

; 5b. Store the current TD as an error packet.

; If an error packet is already stored for this pipe,

; If an error packet is already stored for this pipe,

; it is definitely not used already, so free the old packet.

; it is definitely not used already, so free the old packet.

        test    eax, eax

        test    eax, eax

        jz      @f

        jz      @f

        stdcall uhci_free_td, eax

        stdcall uhci_free_td, eax

@@:

@@:

        mov     eax, [ebx+usb_gtd.Pipe]

        mov     eax, [ebx+usb_gtd.Pipe]

; 5c. Traverse the list of descriptors looking for the final packet

; 5c. 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 7.

; Final descriptor will be freed in step 7.

        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 6 with ecx = 0 (no error).

; After that, go to step 6 with ecx = 0 (no error).

        cmp     ecx, USB_STATUS_UNDERRUN

        cmp     ecx, USB_STATUS_UNDERRUN

        jnz     @f

        jnz     @f

        jnz     @f

        jnz     @f

; The controller has stopped this queue on the error packet.

; The controller has stopped this queue on the error packet.

; Update uhci_pipe.HeadTD to point to the next packet in the queue.

; Update uhci_pipe.HeadTD to point to the next packet in the queue.

        call    uhci_fix_toggle

        call    uhci_fix_toggle

        xor     ecx, ecx

        xor     ecx, ecx

.control:

.control:

        and     al, not 0xF

        and     al, not 0xF

        mov     edx, [ebx+usb_gtd.Pipe]

        mov     edx, [ebx+usb_gtd.Pipe]

        pop     edx     ; length

        pop     edx     ; length

        jmp     .notify

        jmp     .notify

@@:

@@:

; 5f. Abort the entire transfer.

; 5f. Abort the entire transfer.

; There are two cases: either there is only one transfer stage

; There are two cases: either there is only one transfer stage

        jnz     .normal

        jnz     .normal

; We cannot free ErrorTD yet, it could still be used by the hardware.

; We cannot free ErrorTD yet, it could still be used by the hardware.

        push    ecx

        push    ecx

        mov     eax, [ebx+usb_gtd.Pipe]

        mov     eax, [ebx+usb_gtd.Pipe]

        push    [ebx+usb_gtd.NextVirt]

        push    [ebx+usb_gtd.NextVirt]

        jz      @f

        jz      @f

        stdcall uhci_free_td, ebx

        stdcall uhci_free_td, ebx

@@:

@@:

        pop     ebx

        pop     ebx

        call    usb_unlink_td

        call    usb_unlink_td

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

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

        mov     edx, [ebx+usb_gtd.Pipe]

        mov     edx, [ebx+usb_gtd.Pipe]

        cmp     [edx+usb_pipe.Type], CONTROL_PIPE

        cmp     [edx+usb_pipe.Type], CONTROL_PIPE

        jz      .control

        jz      .control

; Bulk/interrupt transfer; halt the queue.

; Bulk/interrupt transfer; halt the queue.

        and     al, not 0xF

        and     al, not 0xF

        inc     eax     ; set Halted bit

        inc     eax     ; set Halted bit

        pop     edx     ; restore length saved in step 5a

        pop     edx     ; restore length saved in step 5a

.notify:

.notify:

; 6. Either the descriptor in ebx was processed without errors,

; 6. Either the descriptor in ebx was processed without errors,

; or all necessary error actions were taken and ebx points to the last

; or all necessary error actions were taken and ebx points to the last

; related descriptor.

; related descriptor.

; 7. Free the current descriptor (if allowed) and return the next one.

; 7. Free the current descriptor (if allowed) and return the next one.

; 7a. Save pointer to the next descriptor.

; 7a. Save pointer to the next descriptor.

        push    [ebx+usb_gtd.NextVirt]

        push    [ebx+usb_gtd.NextVirt]

; 7b. Free the descriptor, unless it is saved as ErrorTD.

; 7b. Free the descriptor, unless it is saved as ErrorTD.

        mov     eax, [ebx+usb_gtd.Pipe]

        mov     eax, [ebx+usb_gtd.Pipe]

        jz      @f

        jz      @f

        stdcall uhci_free_td, ebx

        stdcall uhci_free_td, ebx

@@:

@@:

; 7c. Restore pointer to the next descriptor and return.

; 7c. Restore pointer to the next descriptor and return.

        pop     ebx

        pop     ebx

        cmp     [ecx+usb_pipe.Type], CONTROL_PIPE

        cmp     [ecx+usb_pipe.Type], CONTROL_PIPE

        jz      .nothing

        jz      .nothing

; 2. The hardware expects next packet with toggle = (ErrorTD.toggle xor 1),

; 2. The hardware expects next packet with toggle = (ErrorTD.toggle xor 1),

; the current value in next packet is (ebx.toggle xor 1).

; the current value in next packet is (ebx.toggle xor 1).

; Nothing to do if ErrorTD.toggle == ebx.toggle.

; Nothing to do if ErrorTD.toggle == ebx.toggle.

        test    eax, 1 shl 19

        test    eax, 1 shl 19

        jz      .nothing

        jz      .nothing

; 3. Lock the transfer queue.

; 3. Lock the transfer queue.

        add     ecx, usb_pipe.Lock

        add     ecx, usb_pipe.Lock

        call    mutex_lock

        call    mutex_lock

; 4. Flip the toggle bit in all packets from ebx.NextVirt to ecx.LastTD

; 4. Flip the toggle bit in all packets from ebx.NextVirt to ecx.LastTD

; (inclusive).

; (inclusive).

        mov     eax, [ebx+usb_gtd.NextVirt]

        mov     eax, [ebx+usb_gtd.NextVirt]

.loop:

.loop:

        cmp     eax, [ecx+usb_pipe.LastTD-usb_pipe.Lock]

        cmp     eax, [ecx+usb_pipe.LastTD-usb_pipe.Lock]

        mov     eax, [eax+usb_gtd.NextVirt]

        mov     eax, [eax+usb_gtd.NextVirt]

        jnz     .loop

        jnz     .loop

; 5. Flip the toggle bit in uhci_pipe structure.

; 5. Flip the toggle bit in uhci_pipe structure.

; 6. Unlock the transfer queue.

; 6. Unlock the transfer queue.

        call    mutex_unlock

        call    mutex_unlock

.nothing:

.nothing:

        ret

        ret

endp

endp

; 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 uhci_pipe structure.

; and stores USB device address in the uhci_pipe structure.

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

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

        mov     byte [ebx+uhci_pipe.Token+1-uhci_pipe.SoftwarePart], cl

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

        call    usb_subscription_done

        call    usb_subscription_done

        ret

        ret

endp

endp

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

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

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

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

proc uhci_get_device_address

proc uhci_get_device_address

        mov     al, byte [ebx+uhci_pipe.Token+1-uhci_pipe.SoftwarePart]

        mov     al, byte [ebx+uhci_pipe.Token+1-sizeof.uhci_pipe]

        and     eax, 7Fh

        and     eax, 7Fh

        ret

        ret

; stores the packet size in uhci_pipe structure.

; stores the packet size in uhci_pipe structure.

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

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

proc uhci_set_endpoint_packet_size

proc uhci_set_endpoint_packet_size

        dec     ecx

        dec     ecx

        shl     ecx, 21

        shl     ecx, 21

; uhci_pipe.Token field is purely for software bookkeeping and does not affect

; uhci_pipe.Token field is purely for software bookkeeping and does not affect

; the hardware; thus, we can continue initialization immediately.

; the hardware; thus, we can continue initialization immediately.

        call    usb_subscription_done

        call    usb_subscription_done

        ret

        ret

endp

endp

.maxpacket      dd      ?

.maxpacket      dd      ?

.type           dd      ?

.type           dd      ?

.interval       dd      ?

.interval       dd      ?

end virtual

end virtual

; 1. Initialize ErrorTD to zero.

; 1. Initialize ErrorTD to zero.

; 2. Initialize HeadTD to the physical address of the first TD.

; 2. Initialize HeadTD to the physical address of the first TD.

        push    eax     ; store pointer to the first TD for step ?

        push    eax     ; store pointer to the first TD for step ?

        call    get_phys_addr

        call    get_phys_addr

; 3. Initialize Token field:

; 3. Initialize Token field:

; take DeviceAddress and LowSpeedDevice from the parent pipe,

; take DeviceAddress and LowSpeedDevice from the parent pipe,

; take Endpoint and MaximumLength fields from API arguments,

; take Endpoint and MaximumLength fields from API arguments,

; set PID depending on pipe type and provided pipe direction,

; set PID depending on pipe type and provided pipe direction,

; set DataToggle to zero.

; set DataToggle to zero.

        and     eax, 0x107F00   ; keep DeviceAddress and LowSpeedDevice

        and     eax, 0x107F00   ; keep DeviceAddress and LowSpeedDevice

        mov     edx, [.endpoint]

        mov     edx, [.endpoint]

        and     edx, 15

        and     edx, 15

        shl     edx, 15

        shl     edx, 15

        or      eax, edx

        or      eax, edx

        mov     al, USB_PID_OUT

        mov     al, USB_PID_OUT

        test    byte [.endpoint], 80h

        test    byte [.endpoint], 80h

        jz      @f

        jz      @f

        mov     al, USB_PID_IN

        mov     al, USB_PID_IN

@@:

@@:

; 4. Initialize the first TD:

; 4. Initialize the first TD:

; copy Token from uhci_pipe.Token zeroing reserved bit 20,

; copy Token from uhci_pipe.Token zeroing reserved bit 20,

; set ControlStatus for future transfers, bit make it inactive,

; set ControlStatus for future transfers, bit make it inactive,

; set bit 0 in NextTD = "no next TD".

; set bit 0 in NextTD = "no next TD".

        pop     edx     ; restore pointer saved in step 2

        pop     edx     ; restore pointer saved in step 2

        and     eax, 1 shl 20

        and     eax, 1 shl 20

        shl     eax, 6

        shl     eax, 6

        or      eax, UHCI_INVALID_LENGTH + (3 shl 27)

        or      eax, UHCI_INVALID_LENGTH + (3 shl 27)

                ; not processed, inactive, allow 3 errors

                ; not processed, inactive, allow 3 errors

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

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

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

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

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

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

        cmp     [.type], BULK_PIPE

        cmp     [.type], BULK_PIPE

        jb      .insert ; control pipe

        jb      .insert ; control pipe

        mov     [ecx+usb_pipe.PrevVirt], edi

        mov     [ecx+usb_pipe.PrevVirt], edi

        mov     [edx+usb_pipe.NextVirt], edi

        mov     [edx+usb_pipe.NextVirt], edi

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

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

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

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

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

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

        call    get_phys_addr

        call    get_phys_addr

        inc     eax

        inc     eax

        inc     eax

        inc     eax

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

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

; 6. Return with nonzero eax.

; 6. Return with nonzero eax.

        ret

        ret

endp

endp

; This procedure is called when a pipe is closing (either due to API call

; This procedure is called when a pipe is closing (either due to API call

.err uhci_unlink_pipe assumes that uhci_static_ep.SoftwarePart == uhci_pipe.SoftwarePart

.err uhci_unlink_pipe assumes that uhci_static_ep.SoftwarePart == sizeof.uhci_pipe

end if

end if

proc uhci_unlink_pipe

proc uhci_unlink_pipe

        cmp     [ebx+usb_pipe.Type], INTERRUPT_PIPE

        cmp     [ebx+usb_pipe.Type], INTERRUPT_PIPE

        mov     eax, [ebx+uhci_pipe.Token-uhci_pipe.SoftwarePart]

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

        cmp     al, USB_PID_IN

        cmp     al, USB_PID_IN

        setz    ch

        setz    ch

        bt      eax, 20

        bt      eax, 20

        setc    cl

        setc    cl

        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

; Note: eax could be either usb_pipe or usb_static_ep;

; Note: eax could be either usb_pipe or usb_static_ep;

; fortunately, NextQH and SoftwarePart have same offsets in both.

; fortunately, NextQH and SoftwarePart have same offsets in both.

        ret

        ret

endp

endp

; Free memory associated with pipe.

; Free memory associated with pipe.

; For UHCI, this includes usb_pipe structure and ErrorTD, if present.

; For UHCI, this includes usb_pipe structure and ErrorTD, if present.

proc uhci_free_pipe

proc uhci_free_pipe

        mov     eax, [eax+uhci_pipe.ErrorTD-uhci_pipe.SoftwarePart]

        mov     eax, [eax+uhci_pipe.ErrorTD-sizeof.uhci_pipe]

        test    eax, eax

        test    eax, eax

        jz      @f

        jz      @f

        stdcall uhci_free_td, eax

        stdcall uhci_free_td, eax

@@:

@@:

        mov     [origTD], eax

        mov     [origTD], eax

; In UHCI one TD describes one packet, transfers should be split into parts

; In UHCI one TD describes one packet, transfers should be split into parts

; with size <= endpoint max packet size.

; with size <= endpoint max packet size.

; 2. Get the maximum packet size for endpoint from uhci_pipe.Token

; 2. Get the maximum packet size for endpoint from uhci_pipe.Token

; and generate Token field for TDs.

; and generate Token field for TDs.

        mov     eax, edi

        mov     eax, edi

        shr     edi, 21

        shr     edi, 21

        inc     edi

        inc     edi

; zero packet size (it will be set for every packet individually),

; zero packet size (it will be set for every packet individually),

; zero reserved bit 20,

; zero reserved bit 20,

; 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; uhci_process_finalized_td will handle this

; to skip remaining packets; uhci_process_finalized_td will handle this

; transparently to the caller.

; transparently to the caller.

        test    [flags], 1

        test    [flags], 1

        jz      @f

        jz      @f

@@:

@@:

; 6. Update toggle bit in uhci_pipe structure from current value of [token].

; 6. Update toggle bit in uhci_pipe structure from current value of [token].

        mov     edx, [token]

        mov     edx, [token]

        and     edx, 1 shl 19

        and     edx, 1 shl 19

.nothing:

.nothing:

        ret

        ret

.fail:

.fail:

        mov     edi, uhci_hardware_func

        mov     edi, uhci_hardware_func

        mov     eax, [td]

        mov     eax, [td]

; 4. Initialize the next TD:

; 4. Initialize the next TD:

; mark it as last one (this will be changed when further packets will be

; mark it as last one (this will be changed when further packets will be

; allocated), copy Token field from uhci_pipe.Token zeroing bit 20,

; allocated), copy Token field from uhci_pipe.Token zeroing bit 20,

; generate ControlStatus field, mark as Active

; generate ControlStatus field, mark as Active

; (for last descriptor, this will be changed by uhci_insert_transfer).

; (for last descriptor, this will be changed by uhci_insert_transfer).

        and     edx, 1 shl 20

        and     edx, 1 shl 20

        shl     edx, 6

        shl     edx, 6

        or      edx, UHCI_INVALID_LENGTH + (1 shl 23) + (3 shl 27)

        or      edx, UHCI_INVALID_LENGTH + (1 shl 23) + (3 shl 27)

                ; not processed, active, allow 3 errors

                ; not processed, active, allow 3 errors

; 5. Initialize remaining fields of the current TD.

; 5. Initialize remaining fields of the current TD.

; 5a. Store pointer to the buffer allocated in step 1 (or zero).

; 5a. Store pointer to the buffer allocated in step 1 (or zero).

; 5b. Store physical address of the next TD.

; 5b. Store physical address of the next TD.

        push    eax

        push    eax

        call    get_phys_addr

        call    get_phys_addr

; use Depth traversal unless this is the first TD in the transfer stage;

; use Depth traversal unless this is the first TD in the transfer stage;

; uhci_insert_transfer will set Depth traversal for the first TD and clear

; uhci_insert_transfer will set Depth traversal for the first TD and clear

; it in the last TD

; it in the last TD

        cmp     ecx, [ebx+usb_pipe.LastTD]

        cmp     ecx, [ebx+usb_pipe.LastTD]

        jz      @f

        jz      @f

        or      eax, 4

        or      eax, 4

@@:

@@:

; 5c. Store physical address of the buffer: zero if no data present,

; 5c. Store physical address of the buffer: zero if no data present,

; the temporary buffer if it was allocated, the given buffer otherwise.

; the temporary buffer if it was allocated, the given buffer otherwise.

        xor     eax, eax

        xor     eax, eax

        cmp     [.packetSize], eax

        cmp     [.packetSize], eax

        jz      .hasphysbuf

        jz      .hasphysbuf

        mov     eax, [.buffer]

        mov     eax, [.buffer]

        test    edx, edx

        test    edx, edx

        jz      @f

        jz      @f

        mov     eax, [edx+uhci_original_buffer.UsedBuffer]

        mov     eax, [edx+uhci_original_buffer.UsedBuffer]

@@:

@@:

        call    get_phys_addr

        call    get_phys_addr

.hasphysbuf:

.hasphysbuf:

; 5d. For IN transfers, disallow short packets.

; 5d. For IN transfers, disallow short packets.

; This will be overridden, if needed, by uhci_alloc_transfer.

; This will be overridden, if needed, by uhci_alloc_transfer.

        mov     eax, [.token]

        mov     eax, [.token]

        mov     edx, [.packetSize]

        mov     edx, [.packetSize]

        dec     edx

        dec     edx

        cmp     al, USB_PID_IN

        cmp     al, USB_PID_IN

        jnz     @f

        jnz     @f

@@:

@@:

; 5e. Get Token field: combine [.token] with [.packetSize].

; 5e. Get Token field: combine [.token] with [.packetSize].

        shl     edx, 21

        shl     edx, 21

        or      edx, eax

        or      edx, eax

; 6. Flip toggle bit in [.token].

; 6. Flip toggle bit in [.token].

        xor     eax, 1 shl 19

        xor     eax, 1 shl 19

        mov     [.token], eax

        mov     [.token], eax

; 7. Return pointer to the next TD.

; 7. Return pointer to the next TD.

        pop     eax

        pop     eax

; and activates the transfer which was previously allocated by

; and activates the transfer which was previously allocated by

; uhci_alloc_transfer.

; uhci_alloc_transfer.

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

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

proc uhci_insert_transfer

proc uhci_insert_transfer

;       DEBUGF 1,'K : uhci_insert_transfer: eax=%x, ecx=%x, [esp+4]=%x\n',eax,ecx,[esp+4]

;       DEBUGF 1,'K : uhci_insert_transfer: eax=%x, ecx=%x, [esp+4]=%x\n',eax,ecx,[esp+4]

        mov     eax, [esp+4]

        mov     eax, [esp+4]

        ret

        ret

endp

endp

; Free all memory associated with one TD.

; Free all memory associated with one TD.

; For UHCI, this includes memory for uhci_gtd itself

; For UHCI, this includes memory for uhci_gtd itself

; and the temporary buffer, if present.

; and the temporary buffer, if present.

proc uhci_free_td

proc uhci_free_td

        mov     eax, [eax+uhci_gtd.OrigBufferInfo-uhci_gtd.SoftwarePart]

        mov     eax, [eax+uhci_gtd.OrigBufferInfo-sizeof.uhci_gtd]

        and     eax, not 1

        and     eax, not 1

        jz      .nobuf

        jz      .nobuf

        push    ebx

        push    ebx

        call    free

        call    free

        pop     ebx

        pop     ebx

        sub     dword [esp+4], uhci_gtd.SoftwarePart

        sub     dword [esp+4], sizeof.uhci_gtd

        jmp     usb_free_common

        jmp     usb_free_common