Changeset a7e2f0d in mainline for uspace/drv/uhci-hcd/uhci.c


Ignore:
Timestamp:
2011-03-07T18:57:00Z (14 years ago)
Author:
Jan Vesely <jano.vesely@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
18e9eeb
Parents:
0d3167e
Message:

Doxygen and other comments

File:
1 edited

Legend:

Unmodified
Added
Removed

  • uspace/drv/uhci-hcd/uhci.c

    r0d3167e ra7e2f0d  
    6161};
    6262
    63 static int usb_iface_get_address(ddf_fun_t *fun, devman_handle_t handle,
    64     usb_address_t *address)
     63/** Gets USB address of the calling device.
     64 *
     65 * @param[in] fun UHCI hc function.
     66 * @param[in] handle Handle of the device seeking address.
     67 * @param[out] address Place to store found address.
     68 * @return Error code.
     69 */
     70static int usb_iface_get_address(
     71    ddf_fun_t *fun, devman_handle_t handle, usb_address_t *address)
    6572{
    6673        assert(fun);
    … …  
    99106
    100107static bool allowed_usb_packet(
    101         bool low_speed, usb_transfer_type_t, size_t size);
    102 
    103 
     108    bool low_speed, usb_transfer_type_t transfer, size_t size);
     109/*----------------------------------------------------------------------------*/
     110/** Initializes UHCI hcd driver structure
     111 *
     112 * @param[in] instance Memory place to initialize.
     113 * @param[in] dev DDF device.
     114 * @param[in] regs Address of I/O control registers.
     115 * @param[in] size Size of I/O control registers.
     116 * @return Error code.
     117 * @note Should be called only once on any structure.
     118 */
    104119int uhci_init(uhci_t *instance, ddf_dev_t *dev, void *regs, size_t reg_size)
    105120{
    … …  
    156171}
    157172/*----------------------------------------------------------------------------*/
     173/** Initializes UHCI hcd hw resources.
     174 *
     175 * @param[in] instance UHCI structure to use.
     176 */
    158177void uhci_init_hw(uhci_t *instance)
    159178{
    160179        assert(instance);
    161 
    162         /* reset everything, who knows what touched it before us */
    163         pio_write_16(&instance->registers->usbcmd, UHCI_CMD_GLOBAL_RESET);
     180        regs_t *registers = instance->registers;
     181
     182        /* Reset everything, who knows what touched it before us */
     183        pio_write_16(&registers->usbcmd, UHCI_CMD_GLOBAL_RESET);
    164184        async_usleep(10000); /* 10ms according to USB spec */
    165         pio_write_16(&instance->registers->usbcmd, 0);
    166 
    167         /* reset hc, all states and counters */
    168         pio_write_16(&instance->registers->usbcmd, UHCI_CMD_HCRESET);
     185        pio_write_16(&registers->usbcmd, 0);
     186
     187        /* Reset hc, all states and counters */
     188        pio_write_16(&registers->usbcmd, UHCI_CMD_HCRESET);
    169189        do { async_usleep(10); }
    170         while ((pio_read_16(&instance->registers->usbcmd) & UHCI_CMD_HCRESET) != 0);
    171 
    172         /* set framelist pointer */
     190        while ((pio_read_16(&registers->usbcmd) & UHCI_CMD_HCRESET) != 0);
     191
     192        /* Set framelist pointer */
    173193        const uint32_t pa = addr_to_phys(instance->frame_list);
    174         pio_write_32(&instance->registers->flbaseadd, pa);
    175 
    176         /* enable all interrupts, but resume interrupt */
     194        pio_write_32(&registers->flbaseadd, pa);
     195
     196        /* Enable all interrupts, but resume interrupt */
    177197//      pio_write_16(&instance->registers->usbintr,
    178198//          UHCI_INTR_CRC | UHCI_INTR_COMPLETE | UHCI_INTR_SHORT_PACKET);
    179199
    180         uint16_t status = pio_read_16(&instance->registers->usbcmd);
    181         usb_log_warning("Previous command value: %x.\n", status);
     200        uint16_t status = pio_read_16(&registers->usbcmd);
     201        if (status != 0)
     202                usb_log_warning("Previous command value: %x.\n", status);
     203
    182204        /* Start the hc with large(64B) packet FSBR */
    183         pio_write_16(&instance->registers->usbcmd,
     205        pio_write_16(&registers->usbcmd,
    184206            UHCI_CMD_RUN_STOP | UHCI_CMD_MAX_PACKET | UHCI_CMD_CONFIGURE);
    185207}
    186208/*----------------------------------------------------------------------------*/
     209/** Initializes UHCI hcd memory structures.
     210 *
     211 * @param[in] instance UHCI structure to use.
     212 * @return Error code
     213 * @note Should be called only once on any structure.
     214 */
    187215int uhci_init_mem_structures(uhci_t *instance)
    188216{
    … …  
    196224        } else (void) 0
    197225
    198         /* init interrupt code */
     226        /* Init interrupt code */
    199227        instance->interrupt_code.cmds = malloc(sizeof(uhci_cmds));
    200228        int ret = (instance->interrupt_code.cmds == NULL) ? ENOMEM : EOK;
    201         CHECK_RET_DEST_CMDS_RETURN(ret, "Failed to allocate interrupt cmds space.\n");
     229        CHECK_RET_DEST_CMDS_RETURN(ret,
     230            "Failed to allocate interrupt cmds space.\n");
    202231
    203232        {
    204233                irq_cmd_t *interrupt_commands = instance->interrupt_code.cmds;
    205234                memcpy(interrupt_commands, uhci_cmds, sizeof(uhci_cmds));
    206                 interrupt_commands[0].addr = (void*)&instance->registers->usbsts;
    207                 interrupt_commands[1].addr = (void*)&instance->registers->usbsts;
     235                interrupt_commands[0].addr =
     236                    (void*)&instance->registers->usbsts;
     237                interrupt_commands[1].addr =
     238                    (void*)&instance->registers->usbsts;
    208239                instance->interrupt_code.cmdcount =
    209240                    sizeof(uhci_cmds) / sizeof(irq_cmd_t);
    210241        }
    211242
    212         /* init transfer lists */
     243        /* Init transfer lists */
    213244        ret = uhci_init_transfer_lists(instance);
    214         CHECK_RET_DEST_CMDS_RETURN(ret, "Failed to initialize transfer lists.\n");
     245        CHECK_RET_DEST_CMDS_RETURN(ret, "Failed to init transfer lists.\n");
    215246        usb_log_debug("Initialized transfer lists.\n");
    216247
    217         /* frame list initialization */
     248        /* Init USB frame list page*/
    218249        instance->frame_list = get_page();
    219250        ret = instance ? EOK : ENOMEM;
    … …  
    221252        usb_log_debug("Initialized frame list.\n");
    222253
    223         /* initialize all frames to point to the first queue head */
     254        /* Set all frames to point to the first queue head */
    224255        const uint32_t queue =
    225256          instance->transfers_interrupt.queue_head_pa
    … …  
    231262        }
    232263
    233         /* init address keeper(libusb) */
     264        /* Init device keeper*/
    234265        device_keeper_init(&instance->device_manager);
    235266        usb_log_debug("Initialized device manager.\n");
    … …  
    239270}
    240271/*----------------------------------------------------------------------------*/
     272/** Initializes UHCI hcd transfer lists.
     273 *
     274 * @param[in] instance UHCI structure to use.
     275 * @return Error code
     276 * @note Should be called only once on any structure.
     277 */
    241278int uhci_init_transfer_lists(uhci_t *instance)
    242279{
    … …  
    257294        CHECK_RET_CLEAR_RETURN(ret, "Failed to init BULK list.");
    258295
    259         ret = transfer_list_init(&instance->transfers_control_full, "CONTROL_FULL");
     296        ret = transfer_list_init(
     297            &instance->transfers_control_full, "CONTROL_FULL");
    260298        CHECK_RET_CLEAR_RETURN(ret, "Failed to init CONTROL FULL list.");
    261299
    262         ret = transfer_list_init(&instance->transfers_control_slow, "CONTROL_SLOW");
     300        ret = transfer_list_init(
     301            &instance->transfers_control_slow, "CONTROL_SLOW");
    263302        CHECK_RET_CLEAR_RETURN(ret, "Failed to init CONTROL SLOW list.");
    264303
    … …  
    279318#endif
    280319
    281         instance->transfers[0][USB_TRANSFER_INTERRUPT] =
     320        /* Assign pointers to be used during scheduling */
     321        instance->transfers[USB_SPEED_FULL][USB_TRANSFER_INTERRUPT] =
    282322          &instance->transfers_interrupt;
    283         instance->transfers[1][USB_TRANSFER_INTERRUPT] =
     323        instance->transfers[USB_SPEED_LOW][USB_TRANSFER_INTERRUPT] =
    284324          &instance->transfers_interrupt;
    285         instance->transfers[0][USB_TRANSFER_CONTROL] =
     325        instance->transfers[USB_SPEED_FULL][USB_TRANSFER_CONTROL] =
    286326          &instance->transfers_control_full;
    287         instance->transfers[1][USB_TRANSFER_CONTROL] =
     327        instance->transfers[USB_SPEED_LOW][USB_TRANSFER_CONTROL] =
    288328          &instance->transfers_control_slow;
    289         instance->transfers[0][USB_TRANSFER_BULK] =
     329        instance->transfers[USB_SPEED_FULL][USB_TRANSFER_BULK] =
    290330          &instance->transfers_bulk_full;
    291331
    … …  
    294334}
    295335/*----------------------------------------------------------------------------*/
     336/** Schedules batch for execution.
     337 *
     338 * @param[in] instance UHCI structure to use.
     339 * @param[in] batch Transfer batch to schedule.
     340 * @return Error code
     341 */
    296342int uhci_schedule(uhci_t *instance, batch_t *batch)
    297343{
    … …  
    301347        if (!allowed_usb_packet(
    302348            low_speed, batch->transfer_type, batch->max_packet_size)) {
    303                 usb_log_warning("Invalid USB packet specified %s SPEED %d %zu.\n",
     349                usb_log_warning(
     350                    "Invalid USB packet specified %s SPEED %d %zu.\n",
    304351                    low_speed ? "LOW" : "FULL" , batch->transfer_type,
    305352                    batch->max_packet_size);
    … …  
    316363}
    317364/*----------------------------------------------------------------------------*/
     365/** Takes action based on the interrupt cause.
     366 *
     367 * @param[in] instance UHCI structure to use.
     368 * @param[in] status Value of the stsatus regiser at the time of interrupt.
     369 */
    318370void uhci_interrupt(uhci_t *instance, uint16_t status)
    319371{
    320372        assert(instance);
     373        /* TODO: Check interrupt cause here */
    321374        transfer_list_remove_finished(&instance->transfers_interrupt);
    322375        transfer_list_remove_finished(&instance->transfers_control_slow);
    … …  
    325378}
    326379/*----------------------------------------------------------------------------*/
     380/** Polling function, emulates interrupts.
     381 *
     382 * @param[in] arg UHCI structure to use.
     383 * @return EOK
     384 */
    327385int uhci_interrupt_emulator(void* arg)
    328386{
    … …  
    343401}
    344402/*---------------------------------------------------------------------------*/
     403/** Debug function, checks consistency of memory structures.
     404 *
     405 * @param[in] arg UHCI structure to use.
     406 * @return EOK
     407 */
    345408int uhci_debug_checker(void *arg)
    346409{
    … …  
    401464                async_usleep(UHCI_DEBUGER_TIMEOUT);
    402465        }
    403         return 0;
     466        return EOK;
    404467#undef QH
    405468}
    406469/*----------------------------------------------------------------------------*/
     470/** Checks transfer packets, for USB validity
     471 *
     472 * @param[in] low_speed Transfer speed.
     473 * @param[in] transfer Transer type
     474 * @param[in] size Maximum size of used packets
     475 * @return EOK
     476 */
    407477bool allowed_usb_packet(
    408478    bool low_speed, usb_transfer_type_t transfer, size_t size)
Note: See TracChangeset for help on using the changeset viewer.