iPXE
Data Structures | Functions | Variables
usb_cmd.c File Reference

USB commands. More...

#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <getopt.h>
#include <ipxe/usb.h>
#include <ipxe/command.h>
#include <ipxe/parseopt.h>

Go to the source code of this file.

Data Structures

struct  usbscan_options
 "usbscan" options More...
 

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
 FILE_SECBOOT (PERMITTED)
 
static int usbscan_exec (int argc, char **argv)
 "usbscan" command More...
 
 COMMAND (usbscan, usbscan_exec)
 USB commands. More...
 

Variables

static struct option_descriptor usbscan_opts [] = {}
 "usbscan" option list More...
 
static struct command_descriptor usbscan_cmd
 "usbscan" command descriptor More...
 

Detailed Description

USB commands.

Definition in file usb_cmd.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ FILE_SECBOOT()

FILE_SECBOOT ( PERMITTED  )

◆ usbscan_exec()

static int usbscan_exec ( int  argc,
char **  argv 
)
static

"usbscan" command

Parameters
argcArgument count
argvArgument list
Return values
rcReturn status code

Definition at line 59 of file usb_cmd.c.

59  {
60  struct usbscan_options opts;
61  struct named_setting setting;
62  struct usb_device *usb;
63  unsigned long prev;
64  uint16_t busdev;
65  int len;
66  int rc;
67 
68  /* Parse options */
69  if ( ( rc = parse_options ( argc, argv, &usbscan_cmd, &opts ) ) != 0 )
70  goto err_parse_options;
71 
72  /* Parse setting name */
73  if ( ( rc = parse_autovivified_setting ( argv[optind],
74  &setting ) ) != 0 )
75  goto err_parse_setting;
76 
77  /* Determine starting bus:dev.fn address */
78  if ( ( len = fetchn_setting ( setting.settings, &setting.setting,
79  NULL, &setting.setting, &prev ) ) < 0 ) {
80  /* Setting not yet defined: start searching from 00:00 */
81  busdev = 0;
82  } else {
83  /* Setting is defined: start searching from next location */
84  busdev = ( prev + 1 );
85  if ( ! busdev ) {
86  rc = -ENOENT;
87  goto err_end;
88  }
89  }
90 
91  /* Find next existent USB device */
92  if ( ( rc = usb_find_next ( &usb, &busdev ) ) != 0 )
93  goto err_find_next;
94 
95  /* Apply default type if necessary. Use ":uint16" rather than
96  * ":hex" to allow for easy inclusion within a
97  * "${usb/${location}....}" constructed setting.
98  */
99  if ( ! setting.setting.type )
100  setting.setting.type = &setting_type_uint16;
101 
102  /* Store setting */
103  if ( ( rc = storen_setting ( setting.settings, &setting.setting,
104  busdev ) ) != 0 ) {
105  printf ( "Could not store \"%s\": %s\n",
106  setting.setting.name, strerror ( rc ) );
107  goto err_store;
108  }
109 
110  err_store:
111  err_end:
112  err_find_next:
113  err_parse_setting:
114  err_parse_options:
115  return rc;
116 }
rc
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
uint16_t
unsigned short uint16_t
Definition: stdint.h:11
printf
int printf(const char *fmt,...)
Write a formatted string to the console.
Definition: vsprintf.c:465
named_setting
A parsed named setting.
Definition: parseopt.h:123
optind
int optind
Current option index.
Definition: getopt.c:52
usbscan_options
"usbscan" options
Definition: usb_cmd.c:42
usbscan_cmd
static struct command_descriptor usbscan_cmd
"usbscan" command descriptor
Definition: usb_cmd.c:48
storen_setting
int storen_setting(struct settings *settings, const struct setting *setting, unsigned long value)
Store numeric value of setting.
Definition: settings.c:1415
parse_autovivified_setting
int parse_autovivified_setting(char *text, struct named_setting *setting)
Parse and autovivify setting name.
Definition: parseopt.c:337
ENOENT
#define ENOENT
No such file or directory.
Definition: errno.h:515
parse_options
int parse_options(int argc, char **argv, struct command_descriptor *cmd, void *opts)
Parse command-line options.
Definition: parseopt.c:485
setting::name
const char * name
Name.
Definition: settings.h:29
usb_find_next
int usb_find_next(struct usb_device **usb, uint16_t *busdev)
Find next USB device.
Definition: usb.c:2302
len
ring len
Length.
Definition: dwmac.h:231
setting::type
const struct setting_type * type
Setting type.
Definition: settings.h:37
usb_device
A USB device.
Definition: usb.h:723
fetchn_setting
int fetchn_setting(struct settings *settings, const struct setting *setting, struct settings **origin, struct setting *fetched, unsigned long *value)
Fetch numeric value of setting.
Definition: settings.c:1373
strerror
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:79
setting
A setting.
Definition: settings.h:24
opts
static union @447 opts
"cert<xxx>" option list
NULL
#define NULL
NULL pointer (VOID *)
Definition: Base.h:322

References ENOENT, fetchn_setting(), len, setting::name, NULL, optind, opts, parse_autovivified_setting(), parse_options(), printf(), rc, storen_setting(), strerror(), setting::type, usb_find_next(), and usbscan_cmd.

◆ COMMAND()

COMMAND ( usbscan  ,
usbscan_exec   
)

USB commands.

Variable Documentation

◆ usbscan_opts

struct option_descriptor usbscan_opts[] = {}
static

"usbscan" option list

Definition at line 45 of file usb_cmd.c.

◆ usbscan_cmd

struct command_descriptor usbscan_cmd
static
Initial value:
=
COMMAND_DESC ( struct usbscan_options, usbscan_opts, 1, 1,
"<setting>" )
usbscan_options
"usbscan" options
Definition: usb_cmd.c:42
usbscan_opts
static struct option_descriptor usbscan_opts[]
"usbscan" option list
Definition: usb_cmd.c:45
COMMAND_DESC
#define COMMAND_DESC(_struct, _options, _min_args, _max_args, _usage)
Construct command descriptor.
Definition: parseopt.h:109

"usbscan" command descriptor

Definition at line 48 of file usb_cmd.c.

Referenced by usbscan_exec().

Generated by   doxygen 1.8.15