/*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* Copyright (c) 2015 Ruslan Bukin <br@bsdpad.com>
* Copyright (c) 2018 The FreeBSD Foundation
* All rights reserved.
*
* This software was developed by SRI International and the University of
* Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
* ("CTSRD"), as part of the DARPA CRASH research programme.
*
* Portions of this software were developed by Edward Tomasz Napierala
* under sponsorship from the FreeBSD Foundation.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* This file contains the USB template for USB Networking and Serial
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#ifdef USB_GLOBAL_INCLUDE_FILE
#include USB_GLOBAL_INCLUDE_FILE
#else
#include <sys/stdint.h>
#include <sys/stddef.h>
#include <sys/param.h>
#include <sys/queue.h>
#include <sys/types.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/bus.h>
#include <sys/module.h>
#include <sys/lock.h>
#include <sys/mutex.h>
#include <sys/condvar.h>
#include <sys/sysctl.h>
#include <sys/sx.h>
#include <sys/unistd.h>
#include <sys/callout.h>
#include <sys/malloc.h>
#include <sys/priv.h>
#include <dev/usb/usb.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usb_core.h>
#include <dev/usb/usb_cdc.h>
#include <dev/usb/usb_ioctl.h>
#include <dev/usb/usb_util.h>
#include <dev/usb/template/usb_template.h>
#endif /* USB_GLOBAL_INCLUDE_FILE */
#define MODEM_IFACE_0 0
#define MODEM_IFACE_1 1
enum {
SERIALNET_LANG_INDEX,
SERIALNET_MODEM_INDEX,
SERIALNET_ETH_MAC_INDEX,
SERIALNET_ETH_CONTROL_INDEX,
SERIALNET_ETH_DATA_INDEX,
SERIALNET_CONFIGURATION_INDEX,
SERIALNET_MANUFACTURER_INDEX,
SERIALNET_PRODUCT_INDEX,
SERIALNET_SERIAL_NUMBER_INDEX,
SERIALNET_MAX_INDEX,
};
#define SERIALNET_DEFAULT_MODEM "USB Modem Interface"
#define SERIALNET_DEFAULT_ETH_MAC "2A02030405060789AB"
#define SERIALNET_DEFAULT_ETH_CONTROL "USB Ethernet Comm Interface"
#define SERIALNET_DEFAULT_ETH_DATA "USB Ethernet Data Interface"
#define SERIALNET_DEFAULT_CONFIGURATION "Default configuration"
#define SERIALNET_DEFAULT_MANUFACTURER "The FreeBSD Project"
#define SERIALNET_DEFAULT_PRODUCT "SERIALNET"
#define SERIALNET_DEFAULT_SERIAL_NUMBER "January 2015"
static struct usb_string_descriptor serialnet_modem;
static struct usb_string_descriptor serialnet_eth_mac;
static struct usb_string_descriptor serialnet_eth_control;
static struct usb_string_descriptor serialnet_eth_data;
static struct usb_string_descriptor serialnet_configuration;
static struct usb_string_descriptor serialnet_manufacturer;
static struct usb_string_descriptor serialnet_product;
static struct usb_string_descriptor serialnet_serial_number;
static struct sysctl_ctx_list serialnet_ctx_list;
/* prototypes */
static usb_temp_get_string_desc_t serialnet_get_string_desc;
static const struct usb_cdc_union_descriptor eth_union_desc = {
.bLength = sizeof(eth_union_desc),
.bDescriptorType = UDESC_CS_INTERFACE,
.bDescriptorSubtype = UDESCSUB_CDC_UNION,
.bMasterInterface = 0, /* this is automatically updated */
.bSlaveInterface[0] = 1, /* this is automatically updated */
};
static const struct usb_cdc_header_descriptor eth_header_desc = {
.bLength = sizeof(eth_header_desc),
.bDescriptorType = UDESC_CS_INTERFACE,
.bDescriptorSubtype = UDESCSUB_CDC_HEADER,
.bcdCDC[0] = 0x10,
.bcdCDC[1] = 0x01,
};
static const struct usb_cdc_ethernet_descriptor eth_enf_desc = {
.bLength = sizeof(eth_enf_desc),
.bDescriptorType = UDESC_CS_INTERFACE,
.bDescriptorSubtype = UDESCSUB_CDC_ENF,
.iMacAddress = SERIALNET_ETH_MAC_INDEX,
.bmEthernetStatistics = {0, 0, 0, 0},
.wMaxSegmentSize = {0xEA, 0x05},/* 1514 bytes */
.wNumberMCFilters = {0, 0},
.bNumberPowerFilters = 0,
};
static const void *eth_control_if_desc[] = {
ð_union_desc,
ð_header_desc,
ð_enf_desc,
NULL,
};
static const struct usb_temp_packet_size bulk_mps = {
.mps[USB_SPEED_FULL] = 64,
.mps[USB_SPEED_HIGH] = 512,
};
static const struct usb_temp_packet_size intr_mps = {
.mps[USB_SPEED_FULL] = 8,
.mps[USB_SPEED_HIGH] = 8,
};
static const struct usb_temp_endpoint_desc bulk_in_ep = {
.pPacketSize = &bulk_mps,
#ifdef USB_HIP_IN_EP_0
.bEndpointAddress = USB_HIP_IN_EP_0,
#else
.bEndpointAddress = UE_DIR_IN,
#endif
.bmAttributes = UE_BULK,
};
static const struct usb_temp_endpoint_desc bulk_out_ep = {
.pPacketSize = &bulk_mps,
#ifdef USB_HIP_OUT_EP_0
.bEndpointAddress = USB_HIP_OUT_EP_0,
#else
.bEndpointAddress = UE_DIR_OUT,
#endif
.bmAttributes = UE_BULK,
};
static const struct usb_temp_endpoint_desc intr_in_ep = {
.pPacketSize = &intr_mps,
.bEndpointAddress = UE_DIR_IN,
.bmAttributes = UE_INTERRUPT,
};
static const struct usb_temp_endpoint_desc *eth_intr_endpoints[] = {
&intr_in_ep,
NULL,
};
static const struct usb_temp_interface_desc eth_control_interface = {
.ppEndpoints = eth_intr_endpoints,
.ppRawDesc = eth_control_if_desc,
.bInterfaceClass = UICLASS_CDC,
.bInterfaceSubClass = UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL,
.bInterfaceProtocol = UIPROTO_CDC_NONE,
.iInterface = SERIALNET_ETH_CONTROL_INDEX,
};
static const struct usb_temp_endpoint_desc *eth_data_endpoints[] = {
&bulk_in_ep,
&bulk_out_ep,
NULL,
};
static const struct usb_temp_interface_desc eth_data_null_interface = {
.ppEndpoints = NULL, /* no endpoints */
.bInterfaceClass = UICLASS_CDC_DATA,
.bInterfaceSubClass = UISUBCLASS_DATA,
.bInterfaceProtocol = 0,
.iInterface = SERIALNET_ETH_DATA_INDEX,
};
static const struct usb_temp_interface_desc eth_data_interface = {
.ppEndpoints = eth_data_endpoints,
.bInterfaceClass = UICLASS_CDC_DATA,
.bInterfaceSubClass = UISUBCLASS_DATA,
.bInterfaceProtocol = 0,
.iInterface = SERIALNET_ETH_DATA_INDEX,
.isAltInterface = 1, /* this is an alternate setting */
};
static const struct usb_temp_packet_size modem_bulk_mps = {
.mps[USB_SPEED_LOW] = 8,
.mps[USB_SPEED_FULL] = 64,
.mps[USB_SPEED_HIGH] = 512,
};
static const struct usb_temp_packet_size modem_intr_mps = {
.mps[USB_SPEED_LOW] = 8,
.mps[USB_SPEED_FULL] = 8,
.mps[USB_SPEED_HIGH] = 8,
};
static const struct usb_temp_interval modem_intr_interval = {
.bInterval[USB_SPEED_LOW] = 8, /* 8ms */
.bInterval[USB_SPEED_FULL] = 8, /* 8ms */
.bInterval[USB_SPEED_HIGH] = 7, /* 8ms */
};
static const struct usb_temp_endpoint_desc modem_ep_0 = {
.pPacketSize = &modem_intr_mps,
.pIntervals = &modem_intr_interval,
.bEndpointAddress = UE_DIR_IN,
.bmAttributes = UE_INTERRUPT,
};
static const struct usb_temp_endpoint_desc modem_ep_1 = {
.pPacketSize = &modem_bulk_mps,
.bEndpointAddress = UE_DIR_OUT,
.bmAttributes = UE_BULK,
};
static const struct usb_temp_endpoint_desc modem_ep_2 = {
.pPacketSize = &modem_bulk_mps,
.bEndpointAddress = UE_DIR_IN,
.bmAttributes = UE_BULK,
};
static const struct usb_temp_endpoint_desc *modem_iface_0_ep[] = {
&modem_ep_0,
NULL,
};
static const struct usb_temp_endpoint_desc *modem_iface_1_ep[] = {
&modem_ep_1,
&modem_ep_2,
NULL,
};
static const uint8_t modem_raw_desc_0[] = {
0x05, 0x24, 0x00, 0x10, 0x01
};
static const uint8_t modem_raw_desc_1[] = {
0x05, 0x24, 0x06, MODEM_IFACE_0, MODEM_IFACE_1
};
static const uint8_t modem_raw_desc_2[] = {
0x05, 0x24, 0x01, 0x03, MODEM_IFACE_1
};
static const uint8_t modem_raw_desc_3[] = {
0x04, 0x24, 0x02, 0x07
};
static const void *modem_iface_0_desc[] = {
&modem_raw_desc_0,
&modem_raw_desc_1,
&modem_raw_desc_2,
&modem_raw_desc_3,
NULL,
};
static const struct usb_temp_interface_desc modem_iface_0 = {
.ppRawDesc = modem_iface_0_desc,
.ppEndpoints = modem_iface_0_ep,
.bInterfaceClass = UICLASS_CDC,
.bInterfaceSubClass = UISUBCLASS_ABSTRACT_CONTROL_MODEL,
.bInterfaceProtocol = UIPROTO_CDC_AT,
.iInterface = SERIALNET_MODEM_INDEX,
};
static const struct usb_temp_interface_desc modem_iface_1 = {
.ppEndpoints = modem_iface_1_ep,
.bInterfaceClass = UICLASS_CDC_DATA,
.bInterfaceSubClass = UISUBCLASS_DATA,
.bInterfaceProtocol = 0,
.iInterface = SERIALNET_MODEM_INDEX,
};
static const struct usb_temp_interface_desc *serialnet_interfaces[] = {
&modem_iface_0,
&modem_iface_1,
ð_control_interface,
ð_data_null_interface,
ð_data_interface,
NULL,
};
static const struct usb_temp_config_desc serialnet_config_desc = {
.ppIfaceDesc = serialnet_interfaces,
.bmAttributes = UC_BUS_POWERED,
.bMaxPower = 25, /* 50 mA */
.iConfiguration = SERIALNET_CONFIGURATION_INDEX,
};
static const struct usb_temp_config_desc *serialnet_configs[] = {
&serialnet_config_desc,
NULL,
};
struct usb_temp_device_desc usb_template_serialnet = {
.getStringDesc = &serialnet_get_string_desc,
.ppConfigDesc = serialnet_configs,
.idVendor = USB_TEMPLATE_VENDOR,
.idProduct = 0x0001,
.bcdDevice = 0x0100,
.bDeviceClass = UDCLASS_COMM,
.bDeviceSubClass = 0,
.bDeviceProtocol = 0,
.iManufacturer = SERIALNET_MANUFACTURER_INDEX,
.iProduct = SERIALNET_PRODUCT_INDEX,
.iSerialNumber = SERIALNET_SERIAL_NUMBER_INDEX,
};
/*------------------------------------------------------------------------*
* serialnet_get_string_desc
*
* Return values:
* NULL: Failure. No such string.
* Else: Success. Pointer to string descriptor is returned.
*------------------------------------------------------------------------*/
static const void *
serialnet_get_string_desc(uint16_t lang_id, uint8_t string_index)
{
static const void *ptr[SERIALNET_MAX_INDEX] = {
[SERIALNET_LANG_INDEX] = &usb_string_lang_en,
[SERIALNET_MODEM_INDEX] = &serialnet_modem,
[SERIALNET_ETH_MAC_INDEX] = &serialnet_eth_mac,
[SERIALNET_ETH_CONTROL_INDEX] = &serialnet_eth_control,
[SERIALNET_ETH_DATA_INDEX] = &serialnet_eth_data,
[SERIALNET_CONFIGURATION_INDEX] = &serialnet_configuration,
[SERIALNET_MANUFACTURER_INDEX] = &serialnet_manufacturer,
[SERIALNET_PRODUCT_INDEX] = &serialnet_product,
[SERIALNET_SERIAL_NUMBER_INDEX] = &serialnet_serial_number,
};
if (string_index == 0) {
return (&usb_string_lang_en);
}
if (lang_id != 0x0409) {
return (NULL);
}
if (string_index < SERIALNET_MAX_INDEX) {
return (ptr[string_index]);
}
return (NULL);
}
static void
serialnet_init(void *arg __unused)
{
struct sysctl_oid *parent;
char parent_name[3];
usb_make_str_desc(&serialnet_modem, sizeof(serialnet_modem),
SERIALNET_DEFAULT_MODEM);
usb_make_str_desc(&serialnet_eth_mac, sizeof(serialnet_eth_mac),
SERIALNET_DEFAULT_ETH_MAC);
usb_make_str_desc(&serialnet_eth_control, sizeof(serialnet_eth_control),
SERIALNET_DEFAULT_ETH_CONTROL);
usb_make_str_desc(&serialnet_eth_data, sizeof(serialnet_eth_data),
SERIALNET_DEFAULT_ETH_DATA);
usb_make_str_desc(&serialnet_configuration, sizeof(serialnet_configuration),
SERIALNET_DEFAULT_CONFIGURATION);
usb_make_str_desc(&serialnet_manufacturer, sizeof(serialnet_manufacturer),
SERIALNET_DEFAULT_MANUFACTURER);
usb_make_str_desc(&serialnet_product, sizeof(serialnet_product),
SERIALNET_DEFAULT_PRODUCT);
usb_make_str_desc(&serialnet_serial_number, sizeof(serialnet_serial_number),
SERIALNET_DEFAULT_SERIAL_NUMBER);
snprintf(parent_name, sizeof(parent_name), "%d", USB_TEMP_SERIALNET);
sysctl_ctx_init(&serialnet_ctx_list);
parent = SYSCTL_ADD_NODE(&serialnet_ctx_list,
SYSCTL_STATIC_CHILDREN(_hw_usb_templates), OID_AUTO,
parent_name, CTLFLAG_RW,
0, "USB Mass Storage device side template");
SYSCTL_ADD_U16(&serialnet_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
"vendor_id", CTLFLAG_RWTUN,
&usb_template_serialnet.idVendor, 1, "Vendor identifier");
SYSCTL_ADD_U16(&serialnet_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
"product_id", CTLFLAG_RWTUN,
&usb_template_serialnet.idProduct, 1, "Product identifier");
SYSCTL_ADD_PROC(&serialnet_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
"eth_mac", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
&serialnet_eth_mac, sizeof(serialnet_eth_mac), usb_temp_sysctl,
"A", "Ethernet MAC address string");
#if 0
SYSCTL_ADD_PROC(&serialnet_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
"modem", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
&serialnet_modem, sizeof(serialnet_modem), usb_temp_sysctl,
"A", "Modem interface string");
SYSCTL_ADD_PROC(&serialnet_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
"eth_control", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
&serialnet_eth_control, sizeof(serialnet_eth_data), usb_temp_sysctl,
"A", "Ethernet control interface string");
SYSCTL_ADD_PROC(&serialnet_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
"eth_data", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
&serialnet_eth_data, sizeof(serialnet_eth_data), usb_temp_sysctl,
"A", "Ethernet data interface string");
SYSCTL_ADD_PROC(&serialnet_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
"configuration", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
&serialnet_configuration, sizeof(serialnet_configuration), usb_temp_sysctl,
"A", "Configuration string");
#endif
SYSCTL_ADD_PROC(&serialnet_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
"manufacturer", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
&serialnet_manufacturer, sizeof(serialnet_manufacturer), usb_temp_sysctl,
"A", "Manufacturer string");
SYSCTL_ADD_PROC(&serialnet_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
"product", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
&serialnet_product, sizeof(serialnet_product), usb_temp_sysctl,
"A", "Product string");
SYSCTL_ADD_PROC(&serialnet_ctx_list, SYSCTL_CHILDREN(parent), OID_AUTO,
"serial_number", CTLTYPE_STRING | CTLFLAG_RWTUN | CTLFLAG_MPSAFE,
&serialnet_serial_number, sizeof(serialnet_serial_number), usb_temp_sysctl,
"A", "Serial number string");
}
static void
serialnet_uninit(void *arg __unused)
{
sysctl_ctx_free(&serialnet_ctx_list);
}
SYSINIT(serialnet_init, SI_SUB_LOCK, SI_ORDER_FIRST, serialnet_init, NULL);
SYSUNINIT(serialnet_init, SI_SUB_LOCK, SI_ORDER_FIRST, serialnet_uninit, NULL);