| 1 | /*
|
|---|
| 2 | * Copyright (c) 2017 Jaroslav Jindrak
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup drvusbxhci
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /** @file
|
|---|
| 33 | * Utility functions used to place TRBs onto the command ring.
|
|---|
| 34 | */
|
|---|
| 35 |
|
|---|
| 36 | #ifndef XHCI_COMMANDS_H
|
|---|
| 37 | #define XHCI_COMMANDS_H
|
|---|
| 38 |
|
|---|
| 39 | #include <adt/list.h>
|
|---|
| 40 | #include <stdbool.h>
|
|---|
| 41 | #include <fibril_synch.h>
|
|---|
| 42 | #include "hw_struct/trb.h"
|
|---|
| 43 |
|
|---|
| 44 | /* Useful timeouts for `xhci_cmd_wait()` */
|
|---|
| 45 | #define XHCI_DEFAULT_TIMEOUT 1000000
|
|---|
| 46 | #define XHCI_BLOCK_INDEFINITELY 0
|
|---|
| 47 |
|
|---|
| 48 | typedef struct xhci_hc xhci_hc_t;
|
|---|
| 49 | typedef struct xhci_input_ctx xhci_input_ctx_t;
|
|---|
| 50 | typedef struct xhci_port_bandwidth_ctx xhci_port_bandwidth_ctx_t;
|
|---|
| 51 |
|
|---|
| 52 | typedef struct xhci_command {
|
|---|
| 53 | link_t link;
|
|---|
| 54 |
|
|---|
| 55 | xhci_trb_t trb;
|
|---|
| 56 | uintptr_t trb_phys;
|
|---|
| 57 |
|
|---|
| 58 | uint32_t slot_id;
|
|---|
| 59 | uint32_t status;
|
|---|
| 60 | bool deconfigure;
|
|---|
| 61 |
|
|---|
| 62 | bool completed;
|
|---|
| 63 |
|
|---|
| 64 | /* Will broadcast after command completes. */
|
|---|
| 65 | fibril_mutex_t completed_mtx;
|
|---|
| 66 | fibril_condvar_t completed_cv;
|
|---|
| 67 | } xhci_cmd_t;
|
|---|
| 68 |
|
|---|
| 69 | int xhci_init_commands(xhci_hc_t *);
|
|---|
| 70 | void xhci_fini_commands(xhci_hc_t *);
|
|---|
| 71 |
|
|---|
| 72 | xhci_cmd_t *xhci_cmd_alloc(void);
|
|---|
| 73 | void xhci_cmd_init(xhci_cmd_t *);
|
|---|
| 74 | int xhci_cmd_wait(xhci_cmd_t *, suseconds_t);
|
|---|
| 75 | void xhci_cmd_fini(xhci_cmd_t *);
|
|---|
| 76 | void xhci_cmd_free(xhci_cmd_t *);
|
|---|
| 77 |
|
|---|
| 78 | void xhci_stop_command_ring(xhci_hc_t *);
|
|---|
| 79 | void xhci_abort_command_ring(xhci_hc_t *);
|
|---|
| 80 | void xhci_start_command_ring(xhci_hc_t *);
|
|---|
| 81 |
|
|---|
| 82 | int xhci_send_no_op_command(xhci_hc_t *, xhci_cmd_t *);
|
|---|
| 83 | int xhci_send_enable_slot_command(xhci_hc_t *, xhci_cmd_t *);
|
|---|
| 84 | int xhci_send_disable_slot_command(xhci_hc_t *, xhci_cmd_t *);
|
|---|
| 85 | int xhci_send_address_device_command(xhci_hc_t *, xhci_cmd_t *, xhci_input_ctx_t *);
|
|---|
| 86 | int xhci_send_configure_endpoint_command(xhci_hc_t *, xhci_cmd_t *, xhci_input_ctx_t *);
|
|---|
| 87 | int xhci_send_evaluate_context_command(xhci_hc_t *, xhci_cmd_t *, xhci_input_ctx_t *);
|
|---|
| 88 | int xhci_send_reset_endpoint_command(xhci_hc_t *, xhci_cmd_t *, uint32_t, uint8_t);
|
|---|
| 89 | int xhci_send_stop_endpoint_command(xhci_hc_t *, xhci_cmd_t *, uint32_t, uint8_t);
|
|---|
| 90 | int xhci_send_set_dequeue_ptr_command(xhci_hc_t *, xhci_cmd_t *, uintptr_t, uint16_t, uint32_t);
|
|---|
| 91 | int xhci_send_reset_device_command(xhci_hc_t *, xhci_cmd_t *);
|
|---|
| 92 | // TODO: Force event (optional normative, for VMM, section 4.6.12).
|
|---|
| 93 | // TODO: Negotiate bandwidth (optional normative, section 4.6.13).
|
|---|
| 94 | // TODO: Set latency tolerance value (optional normative, section 4.6.14).
|
|---|
| 95 | int xhci_get_port_bandwidth_command(xhci_hc_t *, xhci_cmd_t *, xhci_port_bandwidth_ctx_t *, uint8_t);
|
|---|
| 96 | // TODO: Get port bandwidth (mandatory, but needs root hub implementation, section 4.6.15).
|
|---|
| 97 | // TODO: Force header (mandatory, but needs root hub implementation, section 4.6.16).
|
|---|
| 98 |
|
|---|
| 99 | int xhci_handle_command_completion(xhci_hc_t *, xhci_trb_t *);
|
|---|
| 100 |
|
|---|
| 101 | #endif
|
|---|
| 102 |
|
|---|
| 103 |
|
|---|
| 104 |
|
|---|
| 105 | /**
|
|---|
| 106 | * @}
|
|---|
| 107 | */
|
|---|
