| // Copyright 2017 The Fuchsia Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| #include <fuchsia/hardware/usb/c/banjo.h> |
| #include <fuchsia/hardware/usb/composite/c/banjo.h> |
| #include <inttypes.h> |
| #include <lib/ddk/debug.h> |
| #include <lib/ddk/driver.h> |
| #include <stdio.h> |
| #include <stdlib.h> |
| #include <string.h> |
| #include <zircon/hw/usb/cdc.h> |
| |
| #include <usb/usb-request.h> |
| |
| #include "src/connectivity/ethernet/drivers/usb-cdc-ecm/ethernet_usb_cdc_ecm-bind.h" |
| #include "usb-cdc-ecm-lib.h" |
| |
| // The maximum amount of memory we are willing to allocate to transaction buffers |
| #define MAX_TX_BUF_SZ 32768 |
| #define MAX_RX_BUF_SZ 1500 * 2048 |
| |
| #define ETHERNET_MAX_TRANSMIT_DELAY 100 |
| #define ETHERNET_MAX_RECV_DELAY 100 |
| #define ETHERNET_TRANSMIT_DELAY 10 |
| #define ETHERNET_RECV_DELAY 10 |
| #define ETHERNET_INITIAL_TRANSMIT_DELAY 0 |
| #define ETHERNET_INITIAL_RECV_DELAY 0 |
| #define ETHERNET_INITIAL_PACKET_FILTER \ |
| (USB_CDC_PACKET_TYPE_DIRECTED | USB_CDC_PACKET_TYPE_BROADCAST | USB_CDC_PACKET_TYPE_MULTICAST) |
| |
| static void complete_txn(txn_info_t* txn, zx_status_t status) { |
| txn->completion_cb(txn->cookie, status, &txn->netbuf); |
| } |
| |
| static void usb_write_complete(void* cookie, usb_request_t* request); |
| |
| static void ecm_unbind(void* cookie) { |
| zxlogf(DEBUG, "%s: unbinding", module_name); |
| ecm_ctx_t* ctx = cookie; |
| |
| mtx_lock(&ctx->tx_mutex); |
| ctx->unbound = true; |
| txn_info_t* txn; |
| while ((txn = list_remove_head_type(&ctx->tx_pending_infos, txn_info_t, node)) != NULL) { |
| complete_txn(txn, ZX_ERR_PEER_CLOSED); |
| } |
| mtx_unlock(&ctx->tx_mutex); |
| |
| device_unbind_reply(ctx->zxdev); |
| } |
| |
| static void ecm_free(ecm_ctx_t* ctx) { |
| zxlogf(DEBUG, "%s: deallocating memory", module_name); |
| if (ctx->int_thread) { |
| thrd_join(ctx->int_thread, NULL); |
| } |
| usb_request_t* txn; |
| while ((txn = usb_req_list_remove_head(&ctx->tx_txn_bufs, ctx->parent_req_size)) != NULL) { |
| usb_request_release(txn); |
| } |
| if (ctx->int_txn_buf) { |
| usb_request_release(ctx->int_txn_buf); |
| } |
| mtx_destroy(&ctx->ethernet_mutex); |
| mtx_destroy(&ctx->tx_mutex); |
| free(ctx); |
| } |
| |
| static void ecm_release(void* ctx) { |
| ecm_ctx_t* eth = ctx; |
| ecm_free(eth); |
| } |
| |
| static zx_protocol_device_t ecm_device_proto = { |
| .version = DEVICE_OPS_VERSION, |
| .unbind = ecm_unbind, |
| .release = ecm_release, |
| }; |
| |
| static void ecm_update_online_status(ecm_ctx_t* ctx, bool is_online) { |
| mtx_lock(&ctx->ethernet_mutex); |
| if ((is_online && ctx->online) || (!is_online && !ctx->online)) { |
| goto done; |
| } |
| |
| if (is_online) { |
| zxlogf(INFO, "%s: connected to network", module_name); |
| ctx->online = true; |
| if (ctx->ethernet_ifc.ops) { |
| ethernet_ifc_status(&ctx->ethernet_ifc, ETHERNET_STATUS_ONLINE); |
| } else { |
| zxlogf(WARNING, "%s: not connected to ethermac interface", module_name); |
| } |
| } else { |
| zxlogf(INFO, "%s: no connection to network", module_name); |
| ctx->online = false; |
| if (ctx->ethernet_ifc.ops) { |
| ethernet_ifc_status(&ctx->ethernet_ifc, 0); |
| } |
| } |
| |
| done: |
| mtx_unlock(&ctx->ethernet_mutex); |
| } |
| |
| static zx_status_t ecm_ethernet_impl_query(void* ctx, uint32_t options, ethernet_info_t* info) { |
| ecm_ctx_t* eth = ctx; |
| |
| zxlogf(DEBUG, "%s: %s called", module_name, __FUNCTION__); |
| |
| // No options are supported |
| if (options) { |
| zxlogf(ERROR, "%s: unexpected options (0x%" PRIx32 ") to ecm_ethernet_impl_query", module_name, |
| options); |
| return ZX_ERR_INVALID_ARGS; |
| } |
| |
| memset(info, 0, sizeof(*info)); |
| info->mtu = eth->mtu; |
| memcpy(info->mac, eth->mac_addr, sizeof(eth->mac_addr)); |
| info->netbuf_size = sizeof(txn_info_t); |
| |
| return ZX_OK; |
| } |
| |
| static void ecm_ethernet_impl_stop(void* cookie) { |
| zxlogf(DEBUG, "%s: %s called", module_name, __FUNCTION__); |
| ecm_ctx_t* ctx = cookie; |
| mtx_lock(&ctx->tx_mutex); |
| mtx_lock(&ctx->ethernet_mutex); |
| ctx->ethernet_ifc.ops = NULL; |
| mtx_unlock(&ctx->ethernet_mutex); |
| mtx_unlock(&ctx->tx_mutex); |
| } |
| |
| static zx_status_t ecm_ethernet_impl_start(void* ctx_cookie, const ethernet_ifc_protocol_t* ifc) { |
| zxlogf(DEBUG, "%s: %s called", module_name, __FUNCTION__); |
| ecm_ctx_t* ctx = ctx_cookie; |
| zx_status_t status = ZX_OK; |
| |
| mtx_lock(&ctx->ethernet_mutex); |
| if (ctx->ethernet_ifc.ops) { |
| status = ZX_ERR_ALREADY_BOUND; |
| } else { |
| ctx->ethernet_ifc = *ifc; |
| ethernet_ifc_status(&ctx->ethernet_ifc, ctx->online ? ETHERNET_STATUS_ONLINE : 0); |
| } |
| mtx_unlock(&ctx->ethernet_mutex); |
| |
| return status; |
| } |
| |
| static zx_status_t queue_request(ecm_ctx_t* ctx, const uint8_t* data, size_t length, |
| usb_request_t* req) { |
| req->header.length = length; |
| if (!ctx->ethernet_ifc.ops) { |
| return ZX_ERR_BAD_STATE; |
| } |
| ssize_t bytes_copied = usb_request_copy_to(req, data, length, 0); |
| if (bytes_copied < 0) { |
| zxlogf(ERROR, "%s: failed to copy data into send txn (error %zd)", module_name, bytes_copied); |
| return ZX_ERR_IO; |
| } |
| usb_request_complete_t complete = { |
| .callback = usb_write_complete, |
| .ctx = ctx, |
| }; |
| usb_request_queue(&ctx->usb, req, &complete); |
| return ZX_OK; |
| } |
| |
| static zx_status_t send_locked(ecm_ctx_t* ctx, ethernet_netbuf_t* netbuf) { |
| const uint8_t* byte_data = netbuf->data_buffer; |
| size_t length = netbuf->data_size; |
| |
| // Make sure that we can get all of the tx buffers we need to use |
| usb_request_t* tx_req = usb_req_list_remove_head(&ctx->tx_txn_bufs, ctx->parent_req_size); |
| if (tx_req == NULL) { |
| return ZX_ERR_SHOULD_WAIT; |
| } |
| |
| zx_nanosleep(zx_deadline_after(ZX_USEC(ctx->tx_endpoint_delay))); |
| zx_status_t status; |
| if ((status = queue_request(ctx, byte_data, length, tx_req)) != ZX_OK) { |
| zx_status_t add_status = usb_req_list_add_tail(&ctx->tx_txn_bufs, tx_req, ctx->parent_req_size); |
| ZX_DEBUG_ASSERT(add_status == ZX_OK); |
| return status; |
| } |
| |
| return ZX_OK; |
| } |
| |
| // Write completion callback. Normally -- this will simply acquire the TX lock, release it, |
| // and re-queue the USB request. |
| // The error case is a bit more complicated. We set the reset bit on the request, and queue |
| // a packet that triggers a reset (asynchronously). We then immediately return to the interrupt |
| // thread with the lock held to allow for interrupt processing to take place. Once the reset |
| // completes, this function is called again with the lock still held, and request processing |
| // continues normally. It is necessary to keep the lock held after returning in the error case |
| // because we do not want other packets to get queued out-of-order while the asynchronous operation |
| // is in progress. |
| static void usb_write_complete(void* cookie, |
| usb_request_t* request) __TA_NO_THREAD_SAFETY_ANALYSIS { |
| ecm_ctx_t* ctx = cookie; |
| |
| if (request->response.status == ZX_ERR_IO_NOT_PRESENT) { |
| usb_request_release(request); |
| return; |
| } |
| // If reset, we still hold the TX mutex. |
| if (!request->reset) { |
| mtx_lock(&ctx->tx_mutex); |
| // Return transmission buffer to pool |
| zx_status_t status = usb_req_list_add_tail(&ctx->tx_txn_bufs, request, ctx->parent_req_size); |
| ZX_DEBUG_ASSERT(status == ZX_OK); |
| if (request->response.status == ZX_ERR_IO_REFUSED) { |
| zxlogf(DEBUG, "%s: resetting transmit endpoint", module_name); |
| request->reset = true; |
| request->reset_address = ctx->tx_endpoint.addr; |
| usb_request_complete_t complete = { |
| .callback = usb_write_complete, |
| .ctx = ctx, |
| }; |
| usb_request_queue(&ctx->usb, request, &complete); |
| return; |
| } |
| |
| if (request->response.status == ZX_ERR_IO_INVALID) { |
| zxlogf(DEBUG, |
| "%s: slowing down the requests by %d usec." |
| "Resetting the transmit endpoint\n", |
| module_name, ETHERNET_TRANSMIT_DELAY); |
| if (ctx->tx_endpoint_delay < ETHERNET_MAX_TRANSMIT_DELAY) { |
| ctx->tx_endpoint_delay += ETHERNET_TRANSMIT_DELAY; |
| } |
| request->reset = true; |
| request->reset_address = ctx->tx_endpoint.addr; |
| usb_request_complete_t complete = { |
| .callback = usb_write_complete, |
| .ctx = ctx, |
| }; |
| usb_request_queue(&ctx->usb, request, &complete); |
| return; |
| } |
| } |
| request->reset = false; |
| |
| bool additional_tx_queued = false; |
| txn_info_t* txn; |
| zx_status_t send_status = ZX_OK; |
| if (!list_is_empty(&ctx->tx_pending_infos)) { |
| txn = list_peek_head_type(&ctx->tx_pending_infos, txn_info_t, node); |
| if ((send_status = send_locked(ctx, &txn->netbuf)) != ZX_ERR_SHOULD_WAIT) { |
| list_remove_head(&ctx->tx_pending_infos); |
| additional_tx_queued = true; |
| } |
| } |
| |
| mtx_unlock(&ctx->tx_mutex); |
| |
| mtx_lock(&ctx->ethernet_mutex); |
| if (additional_tx_queued) { |
| complete_txn(txn, send_status); |
| } |
| mtx_unlock(&ctx->ethernet_mutex); |
| |
| // When the interface is offline, the transaction will complete with status set to |
| // ZX_ERR_IO_NOT_PRESENT. There's not much we can do except ignore it. |
| } |
| |
| // Note: the assumption made here is that no rx transmissions will be processed in parallel, |
| // so we do not maintain an rx mutex. |
| static void usb_recv(ecm_ctx_t* ctx, usb_request_t* request) { |
| size_t len = request->response.actual; |
| |
| uint8_t* read_data; |
| zx_status_t status = usb_request_mmap(request, (void*)&read_data); |
| if (status != ZX_OK) { |
| zxlogf(ERROR, "%s: usb_request_mmap failed with status %d", module_name, status); |
| return; |
| } |
| |
| mtx_lock(&ctx->ethernet_mutex); |
| if (ctx->ethernet_ifc.ops) { |
| ethernet_ifc_recv(&ctx->ethernet_ifc, read_data, len, 0); |
| } |
| mtx_unlock(&ctx->ethernet_mutex); |
| } |
| |
| static void usb_read_complete(void* cookie, usb_request_t* request) __TA_NO_THREAD_SAFETY_ANALYSIS { |
| ecm_ctx_t* ctx = cookie; |
| if (request->response.status != ZX_OK) { |
| zxlogf(DEBUG, "%s: usb_read_complete called with status %d", module_name, |
| (int)request->response.status); |
| } |
| |
| if (request->response.status == ZX_ERR_IO_NOT_PRESENT) { |
| usb_request_release(request); |
| return; |
| } |
| |
| if (request->response.status == ZX_ERR_IO_REFUSED) { |
| zxlogf(DEBUG, "%s: resetting receive endpoint", module_name); |
| request->reset = true; |
| request->reset_address = ctx->rx_endpoint.addr; |
| usb_request_complete_t complete = { |
| .callback = usb_read_complete, |
| .ctx = ctx, |
| }; |
| usb_request_queue(&ctx->usb, request, &complete); |
| return; |
| } else if (request->response.status == ZX_ERR_IO_INVALID) { |
| if (ctx->rx_endpoint_delay < ETHERNET_MAX_RECV_DELAY) { |
| ctx->rx_endpoint_delay += ETHERNET_RECV_DELAY; |
| } |
| zxlogf(DEBUG, |
| "%s: slowing down the requests by %d usec." |
| "Resetting the recv endpoint\n", |
| module_name, ETHERNET_RECV_DELAY); |
| request->reset = true; |
| request->reset_address = ctx->rx_endpoint.addr; |
| usb_request_complete_t complete = { |
| .callback = usb_read_complete, |
| .ctx = ctx, |
| }; |
| usb_request_queue(&ctx->usb, request, &complete); |
| return; |
| } else if (request->response.status == ZX_OK && !request->reset) { |
| usb_recv(ctx, request); |
| } |
| if (ctx->rx_endpoint_delay) { |
| zx_nanosleep(zx_deadline_after(ZX_USEC(ctx->rx_endpoint_delay))); |
| } |
| request->reset = false; |
| usb_request_complete_t complete = { |
| .callback = usb_read_complete, |
| .ctx = ctx, |
| }; |
| usb_request_queue(&ctx->usb, request, &complete); |
| } |
| |
| static void ecm_ethernet_impl_queue_tx(void* context, uint32_t options, ethernet_netbuf_t* netbuf, |
| ethernet_impl_queue_tx_callback completion_cb, |
| void* cookie) { |
| ecm_ctx_t* ctx = context; |
| size_t length = netbuf->data_size; |
| zx_status_t status; |
| |
| txn_info_t* txn = containerof(netbuf, txn_info_t, netbuf); |
| txn->completion_cb = completion_cb; |
| txn->cookie = cookie; |
| |
| if (length > ctx->mtu || length == 0) { |
| complete_txn(txn, ZX_ERR_INVALID_ARGS); |
| return; |
| } |
| |
| zxlogf(TRACE, "%s: sending %zu bytes to endpoint 0x%" PRIx8 "", module_name, length, |
| ctx->tx_endpoint.addr); |
| |
| mtx_lock(&ctx->tx_mutex); |
| if (ctx->unbound) { |
| status = ZX_ERR_IO_NOT_PRESENT; |
| } else { |
| status = send_locked(ctx, netbuf); |
| if (status == ZX_ERR_SHOULD_WAIT) { |
| // No buffers available, queue it up |
| list_add_tail(&ctx->tx_pending_infos, &txn->node); |
| } |
| } |
| |
| mtx_unlock(&ctx->tx_mutex); |
| if (status != ZX_ERR_SHOULD_WAIT) { |
| complete_txn(txn, status); |
| } |
| } |
| |
| static zx_status_t ecm_ethernet_impl_manipulate_bits(ecm_ctx_t* eth, uint16_t mode, bool on) { |
| zx_status_t status = ZX_OK; |
| uint16_t bits = eth->rx_packet_filter; |
| |
| if (on) { |
| bits |= mode; |
| } else { |
| bits &= ~mode; |
| } |
| |
| status = usb_control_out(ð->usb, USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE, |
| USB_CDC_SET_ETHERNET_PACKET_FILTER, bits, 0, ZX_TIME_INFINITE, NULL, 0); |
| |
| if (status != ZX_OK) { |
| zxlogf(ERROR, "usb-cdc-ecm: Set packet filter failed: %d", status); |
| return status; |
| } |
| eth->rx_packet_filter = bits; |
| return status; |
| } |
| |
| static zx_status_t ecm_ethernet_impl_set_param(void* cookie, uint32_t param, int32_t value, |
| const uint8_t* data, size_t data_size) { |
| zx_status_t status; |
| ecm_ctx_t* ctx = cookie; |
| |
| mtx_lock(&ctx->tx_mutex); |
| |
| switch (param) { |
| case ETHERNET_SETPARAM_PROMISC: |
| status = ecm_ethernet_impl_manipulate_bits(ctx, USB_CDC_PACKET_TYPE_PROMISCUOUS, (bool)value); |
| break; |
| default: |
| status = ZX_ERR_NOT_SUPPORTED; |
| } |
| |
| mtx_unlock(&ctx->tx_mutex); |
| |
| return status; |
| } |
| |
| static ethernet_impl_protocol_ops_t ethernet_impl_ops = { |
| .query = ecm_ethernet_impl_query, |
| .stop = ecm_ethernet_impl_stop, |
| .start = ecm_ethernet_impl_start, |
| .queue_tx = ecm_ethernet_impl_queue_tx, |
| .set_param = ecm_ethernet_impl_set_param, |
| }; |
| |
| static void ecm_interrupt_complete(void* cookie, usb_request_t* request) { |
| ecm_ctx_t* ctx = cookie; |
| sync_completion_signal(&ctx->completion); |
| } |
| |
| static void ecm_handle_interrupt(ecm_ctx_t* ctx, usb_request_t* request) { |
| if (request->response.actual < sizeof(usb_cdc_notification_t)) { |
| zxlogf(ERROR, "%s: ignored interrupt (size = %ld)", module_name, |
| (long)request->response.actual); |
| return; |
| } |
| |
| usb_cdc_notification_t usb_req = {}; |
| __UNUSED size_t result = |
| usb_request_copy_from(request, &usb_req, sizeof(usb_cdc_notification_t), 0); |
| if (usb_req.bmRequestType == (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE) && |
| usb_req.bNotification == USB_CDC_NC_NETWORK_CONNECTION) { |
| ecm_update_online_status(ctx, usb_req.wValue != 0); |
| } else if (usb_req.bmRequestType == (USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE) && |
| usb_req.bNotification == USB_CDC_NC_CONNECTION_SPEED_CHANGE) { |
| // The ethermac driver doesn't care about speed changes, so even though we track this |
| // information, it's currently unused. |
| if (usb_req.wLength != 8) { |
| zxlogf(ERROR, "%s: invalid size (%" PRIu16 ") for CONNECTION_SPEED_CHANGE notification", |
| module_name, usb_req.wLength); |
| return; |
| } |
| // Data immediately follows notification in packet |
| uint32_t new_us_bps = 0, new_ds_bps = 0; |
| result = usb_request_copy_from(request, &new_us_bps, 4, sizeof(usb_cdc_notification_t)); |
| result = usb_request_copy_from(request, &new_ds_bps, 4, sizeof(usb_cdc_notification_t) + 4); |
| if (new_us_bps != ctx->us_bps) { |
| zxlogf(INFO, "%s: connection speed change... upstream bits/s: %" PRIu32 "", module_name, |
| new_us_bps); |
| ctx->us_bps = new_us_bps; |
| } |
| if (new_ds_bps != ctx->ds_bps) { |
| zxlogf(INFO, "%s: connection speed change... downstream bits/s: %" PRIu32 "", module_name, |
| new_ds_bps); |
| ctx->ds_bps = new_ds_bps; |
| } |
| } else { |
| zxlogf(ERROR, "%s: ignored interrupt (type = %" PRIu8 ", request = %" PRIu8 ")", module_name, |
| usb_req.bmRequestType, usb_req.bNotification); |
| return; |
| } |
| } |
| |
| static int ecm_int_handler_thread(void* cookie) { |
| ecm_ctx_t* ctx = cookie; |
| usb_request_t* txn = ctx->int_txn_buf; |
| |
| usb_request_complete_t complete = { |
| .callback = ecm_interrupt_complete, |
| .ctx = ctx, |
| }; |
| while (true) { |
| sync_completion_reset(&ctx->completion); |
| usb_request_queue(&ctx->usb, txn, &complete); |
| sync_completion_wait(&ctx->completion, ZX_TIME_INFINITE); |
| if (txn->response.status == ZX_OK) { |
| ecm_handle_interrupt(ctx, txn); |
| } else if (txn->response.status == ZX_ERR_PEER_CLOSED || |
| txn->response.status == ZX_ERR_IO_NOT_PRESENT) { |
| zxlogf(DEBUG, "%s: terminating interrupt handling thread", module_name); |
| return txn->response.status; |
| } else if (txn->response.status == ZX_ERR_IO_REFUSED || |
| txn->response.status == ZX_ERR_IO_INVALID) { |
| zxlogf(DEBUG, "%s: resetting interrupt endpoint", module_name); |
| usb_reset_endpoint(&ctx->usb, ctx->int_endpoint.addr); |
| } else { |
| zxlogf(ERROR, "%s: error (%ld) waiting for interrupt - ignoring", module_name, |
| (long)txn->response.status); |
| } |
| } |
| } |
| |
| static void copy_endpoint_info(ecm_endpoint_t* ep_info, usb_endpoint_descriptor_t* desc) { |
| ep_info->addr = desc->b_endpoint_address; |
| ep_info->max_packet_size = desc->w_max_packet_size; |
| } |
| |
| static bool want_interface(usb_interface_descriptor_t* intf, void* arg) { |
| return intf->b_interface_class == USB_CLASS_CDC; |
| } |
| |
| static zx_status_t ecm_bind(void* ctx, zx_device_t* device) { |
| zxlogf(DEBUG, "%s: starting %s", module_name, __FUNCTION__); |
| |
| usb_protocol_t usb; |
| zx_status_t result = device_get_protocol(device, ZX_PROTOCOL_USB, &usb); |
| if (result != ZX_OK) { |
| return result; |
| } |
| usb_composite_protocol_t usb_composite; |
| result = device_get_protocol(device, ZX_PROTOCOL_USB_COMPOSITE, &usb_composite); |
| if (result != ZX_OK) { |
| return result; |
| } |
| |
| // Allocate context |
| ecm_ctx_t* ecm_ctx = calloc(1, sizeof(ecm_ctx_t)); |
| if (!ecm_ctx) { |
| zxlogf(ERROR, "%s: failed to allocate memory for USB CDC ECM driver", module_name); |
| return ZX_ERR_NO_MEMORY; |
| } |
| |
| result = usb_claim_additional_interfaces(&usb_composite, want_interface, NULL); |
| if (result != ZX_OK) { |
| goto fail; |
| } |
| // Initialize context |
| ecm_ctx->usb_device = device; |
| memcpy(&ecm_ctx->usb, &usb, sizeof(ecm_ctx->usb)); |
| list_initialize(&ecm_ctx->tx_txn_bufs); |
| list_initialize(&ecm_ctx->tx_pending_infos); |
| mtx_init(&ecm_ctx->ethernet_mutex, mtx_plain); |
| mtx_init(&ecm_ctx->tx_mutex, mtx_plain); |
| result = usb_control_out(&ecm_ctx->usb, USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE, |
| USB_CDC_SET_ETHERNET_PACKET_FILTER, ETHERNET_INITIAL_PACKET_FILTER, 0, |
| ZX_TIME_INFINITE, NULL, 0); |
| if (result != ZX_OK) { |
| zxlogf(ERROR, "%s: failed to set initial packet filter: %d", module_name, (int)result); |
| goto fail; |
| } |
| ecm_ctx->rx_packet_filter = ETHERNET_INITIAL_PACKET_FILTER; |
| ecm_ctx->parent_req_size = usb_get_request_size(&ecm_ctx->usb); |
| |
| // Find the CDC descriptors and endpoints |
| usb_endpoint_descriptor_t* int_ep = NULL; |
| usb_endpoint_descriptor_t* tx_ep = NULL; |
| usb_endpoint_descriptor_t* rx_ep = NULL; |
| usb_interface_descriptor_t* default_ifc = NULL; |
| usb_interface_descriptor_t* data_ifc = NULL; |
| usb_desc_iter_t iter = {}; |
| result = usb_desc_iter_init(&usb, &iter); |
| if (result != ZX_OK) { |
| goto fail; |
| } |
| result = parse_usb_descriptor(&iter, &int_ep, &tx_ep, &rx_ep, &default_ifc, &data_ifc, ecm_ctx); |
| if (result != ZX_OK) { |
| zxlogf(ERROR, "%s: failed to parse usb descriptor: %d", module_name, (int)result); |
| goto fail; |
| } |
| |
| // Parse endpoint information |
| copy_endpoint_info(&ecm_ctx->int_endpoint, int_ep); |
| copy_endpoint_info(&ecm_ctx->tx_endpoint, tx_ep); |
| copy_endpoint_info(&ecm_ctx->rx_endpoint, rx_ep); |
| |
| ecm_ctx->rx_endpoint_delay = ETHERNET_INITIAL_RECV_DELAY; |
| ecm_ctx->tx_endpoint_delay = ETHERNET_INITIAL_TRANSMIT_DELAY; |
| // Reset by selecting default interface followed by data interface. We can't start |
| // queueing transactions until this is complete. |
| usb_set_interface(&usb, default_ifc->b_interface_number, default_ifc->b_alternate_setting); |
| usb_set_interface(&usb, data_ifc->b_interface_number, data_ifc->b_alternate_setting); |
| |
| // Allocate interrupt transaction buffer |
| usb_request_t* int_buf; |
| uint64_t req_size = ecm_ctx->parent_req_size + sizeof(usb_req_internal_t); |
| zx_status_t alloc_result = usb_request_alloc(&int_buf, ecm_ctx->int_endpoint.max_packet_size, |
| ecm_ctx->int_endpoint.addr, req_size); |
| if (alloc_result != ZX_OK) { |
| result = alloc_result; |
| goto fail; |
| } |
| |
| ecm_ctx->int_txn_buf = int_buf; |
| |
| // Allocate tx transaction buffers |
| uint16_t tx_buf_sz = ecm_ctx->mtu; |
| #if MAX_TX_BUF_SZ < UINT16_MAX |
| if (tx_buf_sz > MAX_TX_BUF_SZ) { |
| zxlogf(ERROR, "%s: insufficient space for even a single tx buffer", module_name); |
| goto fail; |
| } |
| #endif |
| size_t tx_buf_remain = MAX_TX_BUF_SZ; |
| while (tx_buf_remain >= tx_buf_sz) { |
| usb_request_t* tx_buf; |
| zx_status_t alloc_result = |
| usb_request_alloc(&tx_buf, tx_buf_sz, ecm_ctx->tx_endpoint.addr, req_size); |
| tx_buf->direct = true; |
| if (alloc_result != ZX_OK) { |
| result = alloc_result; |
| goto fail; |
| } |
| |
| // As per the CDC-ECM spec, we need to send a zero-length packet to signify the end of |
| // transmission when the endpoint max packet size is a factor of the total transmission size |
| tx_buf->header.send_zlp = true; |
| |
| zx_status_t add_result = |
| usb_req_list_add_head(&ecm_ctx->tx_txn_bufs, tx_buf, ecm_ctx->parent_req_size); |
| ZX_DEBUG_ASSERT(add_result == ZX_OK); |
| |
| tx_buf_remain -= tx_buf_sz; |
| } |
| |
| // Allocate rx transaction buffers |
| uint32_t rx_buf_sz = ecm_ctx->mtu; |
| #if MAX_TX_BUF_SZ < UINT16_MAX |
| if (rx_buf_sz > MAX_RX_BUF_SZ) { |
| zxlogf(ERROR, "%s: insufficient space for even a single rx buffer", module_name); |
| goto fail; |
| } |
| #endif |
| |
| usb_request_complete_t complete = { |
| .callback = usb_read_complete, |
| .ctx = ecm_ctx, |
| }; |
| size_t rx_buf_remain = MAX_RX_BUF_SZ; |
| while (rx_buf_remain >= rx_buf_sz) { |
| usb_request_t* rx_buf; |
| zx_status_t alloc_result = |
| usb_request_alloc(&rx_buf, rx_buf_sz, ecm_ctx->rx_endpoint.addr, req_size); |
| if (alloc_result != ZX_OK) { |
| result = alloc_result; |
| goto fail; |
| } |
| rx_buf->direct = true; |
| usb_request_queue(&ecm_ctx->usb, rx_buf, &complete); |
| rx_buf_remain -= rx_buf_sz; |
| } |
| |
| // Kick off the handler thread |
| int thread_result = thrd_create_with_name(&ecm_ctx->int_thread, ecm_int_handler_thread, ecm_ctx, |
| "ecm_int_handler_thread"); |
| if (thread_result != thrd_success) { |
| zxlogf(ERROR, "%s: failed to create interrupt handler thread (%d)", module_name, thread_result); |
| goto fail; |
| } |
| |
| // Add the device |
| device_add_args_t args = { |
| .version = DEVICE_ADD_ARGS_VERSION, |
| .name = "usb-cdc-ecm", |
| .ctx = ecm_ctx, |
| .ops = &ecm_device_proto, |
| .proto_id = ZX_PROTOCOL_ETHERNET_IMPL, |
| .proto_ops = ðernet_impl_ops, |
| }; |
| result = device_add(ecm_ctx->usb_device, &args, &ecm_ctx->zxdev); |
| if (result < 0) { |
| zxlogf(ERROR, "%s: failed to add device: %d", module_name, (int)result); |
| goto fail; |
| } |
| |
| return ZX_OK; |
| |
| fail: |
| if (iter.desc) { |
| usb_desc_iter_release(&iter); |
| } |
| ecm_free(ecm_ctx); |
| zxlogf(ERROR, "%s: failed to bind", module_name); |
| return result; |
| } |
| |
| static zx_driver_ops_t ecm_driver_ops = { |
| .version = DRIVER_OPS_VERSION, |
| .bind = ecm_bind, |
| }; |
| |
| ZIRCON_DRIVER(ethernet_usb_cdc_ecm, ecm_driver_ops, "zircon", "0.1"); |