iPXE
cdc.c
Go to the documentation of this file.
1/*
2 * Copyright (C) 2015 Michael Brown <mbrown@fensystems.co.uk>.
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License as
6 * published by the Free Software Foundation; either version 2 of the
7 * License, or (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 * 02110-1301, USA.
18 *
19 * You can also choose to distribute this program under the terms of
20 * the Unmodified Binary Distribution Licence (as given in the file
21 * COPYING.UBDL), provided that you have satisfied its requirements.
22 */
23
24FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
25FILE_SECBOOT ( PERMITTED );
26
27#include <stddef.h>
28#include <ipxe/usb.h>
29#include <ipxe/cdc.h>
30
31/** @file
32 *
33 * USB Communications Device Class (CDC)
34 *
35 */
36
37/**
38 * Locate CDC union functional descriptor
39 *
40 * @v config Configuration descriptor
41 * @v interface Interface descriptor
42 * @ret desc Union functional descriptor, or NULL if not found
43 */
48
50 if ( ( desc->header.type == USB_CS_INTERFACE_DESCRIPTOR ) &&
51 ( desc->subtype == CDC_SUBTYPE_UNION ) )
52 return desc;
53 }
54 return NULL;
55}
#define NULL
NULL pointer (VOID *)
Definition Base.h:322
struct cdc_union_descriptor * cdc_union_descriptor(struct usb_configuration_descriptor *config, struct usb_interface_descriptor *interface)
Locate CDC union functional descriptor.
Definition cdc.c:45
USB Communications Device Class (CDC)
#define CDC_SUBTYPE_UNION
Union functional descriptor subtype.
Definition cdc.h:39
struct ena_llq_option desc
Descriptor counts.
Definition ena.h:9
#define FILE_LICENCE(_licence)
Declare a particular licence as applying to a file.
Definition compiler.h:896
#define FILE_SECBOOT(_status)
Declare a file's UEFI Secure Boot permission status.
Definition compiler.h:926
Universal Serial Bus (USB)
#define for_each_interface_descriptor(desc, config, interface)
Iterate over all configuration descriptors within an interface descriptor.
Definition usb.h:394
#define USB_CS_INTERFACE_DESCRIPTOR
A class-specific interface descriptor.
Definition usb.h:346
Union functional descriptor.
Definition cdc.h:29
An object interface.
Definition interface.h:125
A USB configuration descriptor.
Definition usb.h:210
A USB interface descriptor.
Definition usb.h:245