WebSVN – Kolibri OS – Diff – /kernel/trunk/bus/usb/hccommon.inc

 ; USB Host Controller support code: hardware-independent part,
 ; common for all controller types.
-; =============================================================================
-; ================================= Constants =================================
-; =============================================================================
-; USB device must have at least 100ms of stable power before initializing can
-; proceed; one timer tick is 10ms, so enforce delay in 10 ticks
-USB_CONNECT_DELAY = 10
-; USB requires at least 10 ms for reset signalling. Normally, this is one timer
-; tick. However, it is possible that we start reset signalling in the end of
-; interval between timer ticks and then we test time in the start of the next
-; interval; in this case, the delta between [timer_ticks] is 1, but the real
-; time passed is significantly less than 10 ms. To avoid this, we add an extra
-; tick; this guarantees that at least 10 ms have passed.
-USB_RESET_TIME = 2
-; USB requires at least 10 ms of reset recovery, a delay between reset
-; signalling and any commands to device. Add an extra tick for the same reasons
-; as with the previous constant.
-USB_RESET_RECOVERY_TIME = 2
-; =============================================================================
-; ================================ Structures =================================
-; =============================================================================
-; Controller descriptor.
-; This structure represents the common (controller-independent) part
-; of a controller for the USB code. The corresponding controller-dependent
-; part *hci_controller is located immediately before usb_controller.
-struct usb_controller
-; Two following fields organize all controllers in the global linked list.
-Next            dd      ?
-Prev            dd      ?
-HardwareFunc    dd      ?
-; Pointer to usb_hardware_func structure with controller-specific functions.
-NumPorts        dd      ?
-; Number of ports in the root hub.
-SetAddressBuffer        rb      8
-; Buffer for USB control command SET_ADDRESS.
-ExistingAddresses       rd      128/32
-; Bitmask for 128 bits; bit i is cleared <=> address i is free for allocating
-; for new devices. Bit 0 is always set.
-;
-; The hardware is allowed to cache some data from hardware structures.
-; Regular operations are designed considering this,
-; but sometimes it is required to wait for synchronization of hardware cache
-; with modified structures in memory.
-; The code keeps two queues of pipes waiting for synchronization,
-; one for asynchronous (bulk/control) pipes, one for periodic pipes, hardware
-; cache is invalidated under different conditions for those types.
-; Both queues are organized in the same way, as single-linked lists.
-; There are three special positions: the head of list (new pipes are added
-; here), the first pipe to be synchronized at the current iteration,
-; the tail of list (all pipes starting from here are synchronized).
-WaitPipeListAsync       dd      ?
-WaitPipeListPeriodic    dd      ?
-; List heads.
-WaitPipeRequestAsync    dd      ?
-WaitPipeRequestPeriodic dd      ?
-; Pending request to hardware to refresh cache for items from WaitPipeList*.
-; (Pointers to some items in WaitPipeList* or NULLs).
-ReadyPipeHeadAsync      dd      ?
-ReadyPipeHeadPeriodic   dd      ?
-; Items of RemovingList* which were released by hardware and are ready
-; for further processing.
-; (Pointers to some items in WaitPipeList* or NULLs).
-NewConnected    dd      ?
-; bit mask of recently connected ports of the root hub,
-; bit set = a device was recently connected to the corresponding port;
-; after USB_CONNECT_DELAY ticks of stable status these ports are moved to
-; PendingPorts
-NewDisconnected dd      ?
-; bit mask of disconnected ports of the root hub,
-; bit set = a device in the corresponding port was disconnected,
-; disconnect processing is required.
-PendingPorts    dd      ?
-; bit mask of ports which are ready to be initialized
-ControlLock     MUTEX   ?
-; mutex which guards all operations with control queue
-BulkLock        MUTEX   ?
-; mutex which guards all operations with bulk queue
-PeriodicLock    MUTEX   ?
-; mutex which guards all operations with periodic queues
-WaitSpinlock:
-; spinlock guarding WaitPipeRequest/ReadyPipeHead (but not WaitPipeList)
-StartWaitFrame  dd      ?
-; USB frame number when WaitPipeRequest* was registered.
-ResettingHub    dd      ?
-; Pointer to usb_hub responsible for the currently resetting port, if any.
-; NULL for the root hub.
-ResettingPort   db      ?
-; Port that is currently resetting, 0-based.
-ResettingSpeed  db      ?
-; Speed of currently resetting device.
-ResettingStatus db      ?
+iglobal
-; Status of port reset. 0 = no port is resetting, -1 = reset failed,
-; 1 = reset in progress, 2 = reset recovery in progress.
-                rb      1       ; alignment
-ResetTime       dd      ?
-; Time when reset signalling or reset recovery has been started.
-ConnectedTime   rd      16
-; Time, in timer ticks, when the port i has signalled the connect event.
-; Valid only if bit i in NewConnected is set.
-DevicesByPort   rd      16
-; Pointer to usb_pipe for zero endpoint (which serves as device handle)
-; for each port.
-ends
-; Interface-specific data. Several interfaces of one device can operate
-; independently, each is controlled by some driver and is identified by
-; some driver-specific data passed as is to the driver.
-struct usb_interface_data
-DriverData      dd      ?
-; Passed as is to the driver.
-DriverFunc      dd      ?
-; Pointer to USBSRV structure for the driver.
+; USB HC support: some functions interesting only for *HCI-drivers.
-ends
-; Device-specific data.
+align 4
-struct usb_device_data
-PipeListLock    MUTEX
-; Lock guarding OpenedPipeList. Must be the first item of the structure,
-; the code passes pointer to usb_device_data as is to mutex_lock/unlock.
-OpenedPipeList  rd      2
-; List of all opened pipes for the device.
-; Used when the device is disconnected, so all pipes should be closed.
-ClosedPipeList  rd      2
-; List of all closed, but still valid pipes for the device.
-; A pipe closed with USBClosePipe is just deallocated,
-; but a pipe closed due to disconnect must remain valid until driver-provided
-; disconnect handler returns; this list links all such pipes to deallocate them
+usb_hc_func:
-; after disconnect processing.
-NumPipes        dd      ?
+        dd      usb_process_gtd
-; Number of not-yet-closed pipes.
+        dd      usb_init_static_endpoint
-Hub             dd      ?
-; NULL if connected to the root hub, pointer to usb_hub otherwise.
-TTHub           dd      ?
-; Pointer to usb_hub for (the) hub with Transaction Translator for the device,
-; NULL if the device operates in the same speed as the controller.
+        dd      usb_wakeup_if_needed
-Port            db      ?
-; Port on the hub, zero-based.
-TTPort          db      ?
-; Port on the TTHub, zero-based.
-DeviceDescrSize db      ?
+        dd      usb_subscribe_control
-; Size of device descriptor.
-Speed           db      ?
-; Device speed, one of USB_SPEED_*.
-NumInterfaces   dd      ?
-; Number of interfaces.
-ConfigDataSize  dd      ?
-; Total size of data associated with the configuration descriptor
-; (including the configuration descriptor itself).
-Interfaces      dd      ?
-; Offset from the beginning of this structure to Interfaces field.
-; Variable-length fields:
-; DeviceDescriptor:
-;  device descriptor starts here
-; ConfigDescriptor = DeviceDescriptor + DeviceDescrSize
-;  configuration descriptor with all associated data
-; Interfaces = ALIGN_UP(ConfigDescriptor + ConfigDataSize, 4)
-;  array of NumInterfaces elements of type usb_interface_data
-ends
-usb_device_data.DeviceDescriptor = sizeof.usb_device_data
-; Description of controller-specific data and functions.
-struct usb_hardware_func
+        dd      usb_subscription_done
-ID              dd      ?       ; '*HCI'
+        dd      usb_allocate_common
-DataSize        dd      ?       ; sizeof(*hci_controller)
+        dd      usb_free_common
-Init            dd      ?
-; Initialize controller-specific part of controller data.
-; in: eax -> *hci_controller to initialize, [ebp-4] = (bus shl 8) + devfn
-; out: eax = 0 <=> failed, otherwise eax -> usb_controller
-ProcessDeferred dd      ?
-; Called regularly from the main loop of USB thread
-; (either due to timeout from a previous call, or due to explicit wakeup).
+        dd      usb_td_to_virt
-; in: esi -> usb_controller
-; out: eax = maximum timeout for next call (-1 = infinity)
-SetDeviceAddress        dd      ?
-; in: esi -> usb_controller, ebx -> usb_pipe, cl = address
-GetDeviceAddress        dd      ?
-; in: esi -> usb_controller, ebx -> usb_pipe
-; out: eax = address
+        dd      usb_init_transfer
-PortDisable             dd      ?
-; Disable the given port in the root hub.
-; in: esi -> usb_controller, ecx = port (zero-based)
-InitiateReset           dd      ?
+        dd      usb_undo_tds
-; Start reset signalling on the given port.
-; in: esi -> usb_controller, ecx = port (zero-based)
-SetEndpointPacketSize   dd      ?
-; in: esi -> usb_controller, ebx -> usb_pipe, ecx = packet size
+        dd      usb_test_pending_port
-AllocPipe               dd      ?
+        dd      usb_get_tt
-; out: eax = pointer to allocated usb_pipe
-FreePipe                dd      ?
-; void stdcall with one argument = pointer to previously allocated usb_pipe
+        dd      usb_get_tt_think_time
-InitPipe                dd      ?
-; 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
-UnlinkPipe              dd      ?
-; esi -> usb_controller, ebx -> usb_pipe
+        dd      usb_new_device
-AllocTD                 dd      ?
+        dd      usb_disconnect_stage2
-; out: eax = pointer to allocated usb_gtd
+        dd      usb_process_wait_lists
-FreeTD                  dd      ?
-; void stdcall with one argument = pointer to previously allocated usb_gtd
-AllocTransfer           dd      ?
-; Allocate and initialize one stage of a transfer.
-; ebx -> usb_pipe, other parameters are passed through the stack:
-; buffer,size = data to transfer
+        dd      usb_unlink_td
-; 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
-InsertTransfer          dd      ?
-; Activate previously initialized transfer (maybe with multiple stages).
-; esi -> usb_controller, ebx -> usb_pipe,
-; [esp+4] -> first usb_gtd for the transfer,
-; ecx -> last descriptor for the transfer
-NewDevice               dd      ?
-; Initiate configuration of a new device (create pseudo-pipe describing that
+        dd      usb_is_final_packet
-; device and call usb_new_device).
-; esi -> usb_controller, eax = speed (one of USB_SPEED_* constants).
+        dd      usb_find_ehci_companion
-ends
-; =============================================================================
-; =================================== Code ====================================
-; =============================================================================
+endg
 ; Initializes one controller, called by usb_init for every controller.
-; edi -> usb_hardware_func, eax -> PCIDEV structure for the device.
+; eax -> PCIDEV structure for the device.
 proc usb_init_controller
         push    ebp
         mov     ebp, esp
 ; 1. Store in the stack PCI coordinates and save pointer to PCIDEV:
 ; make [ebp-4] = (bus shl 8) + devfn, used by controller-specific Init funcs.
+        push    dword [eax+PCIDEV.devfn]
+        push    eax
+        mov     edi, [eax+PCIDEV.owner]
+        test    edi, edi
-        push    dword [eax+PCIDEV.devfn]
+        jz      .nothing
-        push    eax
+        mov     edi, [edi+USBSRV.usb_func]
 ; 2. Allocate *hci_controller + usb_controller.
         mov     ebx, [edi+usb_hardware_func.DataSize]
         add     ebx, sizeof.usb_controller
         mov     [edi+usb_controller.ExistingAddresses+8-sizeof.usb_controller], eax
         mov     [edi+usb_controller.ExistingAddresses+12-sizeof.usb_controller], eax
         mov     [edi+usb_controller.ResettingPort-sizeof.usb_controller], al    ; no resetting port
         dec     eax     ; don't allocate zero address
         mov     [edi+usb_controller.ExistingAddresses-sizeof.usb_controller], eax
+        mov     eax, [ebp-4]
+        mov     [edi+usb_controller.PCICoordinates-sizeof.usb_controller], eax
         lea     ecx, [edi+usb_controller.PeriodicLock-sizeof.usb_controller]
         call    mutex_init
         add     ecx, usb_controller.ControlLock - usb_controller.PeriodicLock
         call    mutex_init
         add     ecx, usb_controller.BulkLock - usb_controller.ControlLock
         cmp     [esi+usb_controller.WaitPipeListAsync+edx], 1
         cmc
 .nothing:
         ret
 endp
+; Called from USB1 controller-specific initialization.
+; Finds EHCI companion controller for given USB1 controller.
+; in: bl = PCI device:function for USB1 controller, bh = PCI bus
+; out: eax -> usb_controller for EHCI companion
+proc usb_find_ehci_companion
+; 1. Loop over all registered controllers.
+        mov     eax, usb_controllers_list
+.next:
+        mov     eax, [eax+usb_controller.Next]
+        cmp     eax, usb_controllers_list
+        jz      .notfound
+; 2. For every controller, check the type, ignore everything that is not EHCI.
+        mov     edx, [eax+usb_controller.HardwareFunc]
+        cmp     [edx+usb_hardware_func.ID], 'EHCI'
+        jnz     .next
+; 3. For EHCI controller, compare PCI coordinates with input data:
+; bus and device must be the same, function can be different.
+        mov     edx, [eax+usb_controller.PCICoordinates]
+        xor     edx, ebx
+        cmp     dx, 8
+        jae     .next
+        ret
+.notfound:
+        xor     eax, eax
+        ret
+endp
+; Find Transaction Translator hub and port for the given device.
+; in: edx = parent hub for the device, ecx = port for the device
+; out: edx = TT hub for the device, ecx = TT port for the device.
+proc usb_get_tt
+; If the parent hub is high-speed, it is TT for the device.
+; Otherwise, the parent hub itself is behind TT, and the device
+; has the same TT hub+port as the parent hub.
+        mov     eax, [edx+usb_hub.ConfigPipe]
+        mov     eax, [eax+usb_pipe.DeviceData]
+        cmp     [eax+usb_device_data.Speed], USB_SPEED_HS
+        jz      @f
+        movzx   ecx, [eax+usb_device_data.TTPort]
+        mov     edx, [eax+usb_device_data.TTHub]
+@@:
+        mov     edx, [edx+usb_hub.ConfigPipe]
+        ret
+endp

Subversion Repositories Kolibri OS

(root)/kernel/trunk/bus/usb/hccommon.inc – Rev 3826 → 4418