src/vlib/pci/pci.c

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /*
  16  * pci.c: Linux user space PCI bus management.
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #include <vlib/vlib.h>
  41 #include <vlib/pci/pci.h>
  42 #include <vlib/unix/unix.h>
  43
  44 #include <sys/types.h>
  45 #include <sys/stat.h>
  46 #include <fcntl.h>
  47 #include <dirent.h>
  48 #include <sys/ioctl.h>
  49 #include <net/if.h>
  50 #include <linux/ethtool.h>
  51 #include <linux/sockios.h>
  52
  53 vlib_pci_main_t pci_main;
  54
  55 vlib_pci_device_info_t * __attribute__ ((weak))
  56 vlib_pci_get_device_info (vlib_pci_addr_t * addr, clib_error_t ** error)
  57 {
  58   if (error)
  59     *error = clib_error_return (0, "unsupported");
  60   return 0;
  61 }
  62
  63 vlib_pci_addr_t * __attribute__ ((weak)) vlib_pci_get_all_dev_addrs ()
  64 {
  65   return 0;
  66 }
  67
  68 static clib_error_t *
  69 show_pci_fn (vlib_main_t * vm,
  70              unformat_input_t * input, vlib_cli_command_t * cmd)
  71 {
  72   vlib_pci_addr_t *addr = 0, *addrs;
  73   int show_all = 0;
  74   u8 *s = 0;
  75
  76   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
  77     {
  78       if (unformat (input, "all"))
  79         show_all = 1;
  80       else
  81         return clib_error_return (0, "unknown input `%U'",
  82                                   format_unformat_error, input);
  83     }
  84
  85   vlib_cli_output (vm, "%-13s%-5s%-12s%-13s%-16s%-32s%s",
  86                    "Address", "Sock", "VID:PID", "Link Speed", "Driver",
  87                    "Product Name", "Vital Product Data");
  88
  89   addrs = vlib_pci_get_all_dev_addrs ();
  90   /* *INDENT-OFF* */
  91   vec_foreach (addr, addrs)
  92     {
  93       vlib_pci_device_info_t *d;
  94       d = vlib_pci_get_device_info (addr, 0);
  95
  96       if (!d)
  97         continue;
  98
  99       if (d->device_class != PCI_CLASS_NETWORK_ETHERNET && !show_all)
 100         continue;
 101
 102         vec_reset_length (s);
 103         if (d->numa_node >= 0)
 104           s = format (s, "  %d", d->numa_node);
 105
 106         vlib_cli_output (vm, "%-13U%-5v%04x:%04x   %-13U%-16s%-32v%U",
 107                          format_vlib_pci_addr, addr, s,
 108                          d->vendor_id, d->device_id,
 109                          format_vlib_pci_link_speed, d,
 110                          d->driver_name ? (char *) d->driver_name : "",
 111                          d->product_name,
 112                          format_vlib_pci_vpd, d->vpd_r, 0);
 113         vlib_pci_free_device_info (d);
 114     }
 115   /* *INDENT-ON* */
 116
 117   vec_free (s);
 118   vec_free (addrs);
 119   return 0;
 120 }
 121
 122 uword
 123 unformat_vlib_pci_addr (unformat_input_t * input, va_list * args)
 124 {
 125   vlib_pci_addr_t *addr = va_arg (*args, vlib_pci_addr_t *);
 126   u32 x[4];
 127
 128   if (!unformat (input, "%x:%x:%x.%x", &x[0], &x[1], &x[2], &x[3]))
 129     return 0;
 130
 131   addr->domain = x[0];
 132   addr->bus = x[1];
 133   addr->slot = x[2];
 134   addr->function = x[3];
 135
 136   return 1;
 137 }
 138
 139 u8 *
 140 format_vlib_pci_addr (u8 * s, va_list * va)
 141 {
 142   vlib_pci_addr_t *addr = va_arg (*va, vlib_pci_addr_t *);
 143   return format (s, "%04x:%02x:%02x.%x", addr->domain, addr->bus,
 144                  addr->slot, addr->function);
 145 }
 146
 147 u8 *
 148 format_vlib_pci_link_speed (u8 * s, va_list * va)
 149 {
 150   vlib_pci_device_info_t *d = va_arg (*va, vlib_pci_device_info_t *);
 151   pcie_config_regs_t *r =
 152     pci_config_find_capability (&d->config0, PCI_CAP_ID_PCIE);
 153   int width;
 154
 155   if (!r)
 156     return format (s, "unknown");
 157
 158   width = (r->link_status >> 4) & 0x3f;
 159
 160   if ((r->link_status & 0xf) == 1)
 161     return format (s, "2.5 GT/s x%u", width);
 162   if ((r->link_status & 0xf) == 2)
 163     return format (s, "5.0 GT/s x%u", width);
 164   if ((r->link_status & 0xf) == 3)
 165     return format (s, "8.0 GT/s x%u", width);
 166   return format (s, "unknown");
 167 }
 168
 169 u8 *
 170 format_vlib_pci_vpd (u8 * s, va_list * args)
 171 {
 172   u8 *data = va_arg (*args, u8 *);
 173   u8 *id = va_arg (*args, u8 *);
 174   u32 indent = format_get_indent (s);
 175   char *string_types[] = { "PN", "EC", "SN", "MN", 0 };
 176   uword p = 0;
 177   int first_line = 1;
 178
 179   if (vec_len (data) < 3)
 180     return s;
 181
 182   while (p + 3 < vec_len (data))
 183     {
 184
 185       if (data[p] == 0 && data[p + 1] == 0)
 186         return s;
 187
 188       if (p + data[p + 2] > vec_len (data))
 189         return s;
 190
 191       if (id == 0)
 192         {
 193           int is_string = 0;
 194           char **c = string_types;
 195
 196           while (c[0])
 197             {
 198               if (*(u16 *) & data[p] == *(u16 *) c[0])
 199                 is_string = 1;
 200               c++;
 201             }
 202
 203           if (data[p + 2])
 204             {
 205               if (!first_line)
 206                 s = format (s, "\n%U", format_white_space, indent);
 207               else
 208                 {
 209                   first_line = 0;
 210                   s = format (s, " ");
 211                 }
 212
 213               s = format (s, "%c%c: ", data[p], data[p + 1]);
 214               if (is_string)
 215                 vec_add (s, data + p + 3, data[p + 2]);
 216               else
 217                 {
 218                   int i;
 219                   const int max_bytes = 8;
 220                   s = format (s, "0x");
 221                   for (i = 0; i < clib_min (data[p + 2], max_bytes); i++)
 222                     s = format (s, " %02x", data[p + 3 + i]);
 223
 224                   if (data[p + 2] > max_bytes)
 225                     s = format (s, " ...");
 226                 }
 227             }
 228         }
 229       else if (*(u16 *) & data[p] == *(u16 *) id)
 230         {
 231           vec_add (s, data + p + 3, data[p + 2]);
 232           return s;
 233         }
 234
 235       p += 3 + data[p + 2];
 236     }
 237
 238   return s;
 239 }
 240
 241
 242 /* *INDENT-OFF* */
 243 VLIB_CLI_COMMAND (show_pci_command, static) = {
 244   .path = "show pci",
 245   .short_help = "show pci [all]",
 246   .function = show_pci_fn,
 247 };
 248 /* *INDENT-ON* */
 249
 250 clib_error_t *
 251 pci_bus_init (vlib_main_t * vm)
 252 {
 253   return vlib_call_init_function (vm, pci_bus_init);
 254 }
 255
 256 VLIB_INIT_FUNCTION (pci_bus_init);
 257
 258 /*
 259  * fd.io coding-style-patch-verification: ON
 260  *
 261  * Local Variables:
 262  * eval: (c-set-style "gnu")
 263  * End:
 264  */