vlib/vlib/pci/pci.h

   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.h: PCI definitions.
  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 #ifndef included_vlib_pci_h
  41 #define included_vlib_pci_h
  42
  43 #include <vlib/vlib.h>
  44 #include <vlib/pci/pci_config.h>
  45
  46 typedef CLIB_PACKED (union {
  47   struct {
  48     u16 domain;
  49     u8 bus;
  50     u8 slot:5;
  51     u8 function:3;
  52    };
  53    u32 as_u32;
  54 }) vlib_pci_addr_t;
  55
  56 typedef struct vlib_pci_device {
  57   /* Operating system handle for this device. */
  58   uword os_handle;
  59
  60   vlib_pci_addr_t bus_address;
  61
  62   /* First 64 bytes of configuration space. */
  63   union {
  64     pci_config_type0_regs_t config0;
  65     pci_config_type1_regs_t config1;
  66     u8 config_data[256];
  67   };
  68
  69   /* Interrupt handler */
  70   void (* interrupt_handler) (struct vlib_pci_device * dev);
  71
  72   /* Driver name */
  73   u8 * driver_name;
  74
  75   /* Numa Node */
  76   int numa_node;
  77
  78   /* Vital Product Data */
  79   u8 * product_name;
  80   u8 * vpd_r;
  81   u8 * vpd_w;
  82
  83   /* Private data */
  84   uword private_data;
  85
  86 } vlib_pci_device_t;
  87
  88 typedef struct {
  89   u16 vendor_id, device_id;
  90 } pci_device_id_t;
  91
  92 typedef struct _pci_device_registration {
  93   /* Driver init function. */
  94   clib_error_t * (* init_function) (vlib_main_t * vm, vlib_pci_device_t * dev);
  95
  96   /* Interrupt handler */
  97   void (* interrupt_handler) (vlib_pci_device_t * dev);
  98
  99   /* List of registrations */
 100   struct _pci_device_registration * next_registration;
 101
 102   /* Vendor/device ids supported by this driver. */
 103   pci_device_id_t supported_devices[];
 104 } pci_device_registration_t;
 105
 106 /* Pool of PCI devices. */
 107 typedef struct {
 108   vlib_main_t * vlib_main;
 109   vlib_pci_device_t * pci_devs;
 110   pci_device_registration_t * pci_device_registrations;
 111   uword * pci_dev_index_by_pci_addr;
 112 } vlib_pci_main_t;
 113
 114 extern vlib_pci_main_t pci_main;
 115
 116 #define PCI_REGISTER_DEVICE(x,...)                              \
 117     __VA_ARGS__ pci_device_registration_t x;                    \
 118 static void __vlib_add_pci_device_registration_##x (void)       \
 119     __attribute__((__constructor__)) ;                          \
 120 static void __vlib_add_pci_device_registration_##x (void)       \
 121 {                                                               \
 122     vlib_pci_main_t * pm = &pci_main;                           \
 123     x.next_registration = pm->pci_device_registrations;         \
 124     pm->pci_device_registrations = &x;                          \
 125 }                                                               \
 126 __VA_ARGS__ pci_device_registration_t x
 127
 128 clib_error_t *
 129 vlib_pci_bind_to_uio (vlib_pci_device_t * d, char * uio_driver_name);
 130
 131 /* Configuration space read/write. */
 132 clib_error_t *
 133 vlib_pci_read_write_config (vlib_pci_device_t * dev,
 134                             vlib_read_or_write_t read_or_write,
 135                             uword address,
 136                             void * data,
 137                             u32 n_bytes);
 138
 139 #define _(t)                                                            \
 140 static inline clib_error_t *                                            \
 141 vlib_pci_read_config_##t (vlib_pci_device_t * dev,                      \
 142                           uword address, t * data)                      \
 143 {                                                                       \
 144   return vlib_pci_read_write_config (dev, VLIB_READ,address, data,      \
 145                                      sizeof (data[0]));                 \
 146 }
 147
 148 _ (u32);
 149 _ (u16);
 150 _ (u8);
 151
 152 #undef _
 153
 154 #define _(t)                                                            \
 155 static inline clib_error_t *                                            \
 156 vlib_pci_write_config_##t (vlib_pci_device_t * dev, uword address,      \
 157                            t * data)                                    \
 158 {                                                                       \
 159   return vlib_pci_read_write_config (dev, VLIB_WRITE,                   \
 160                                    address, data, sizeof (data[0]));    \
 161 }
 162
 163 _ (u32);
 164 _ (u16);
 165 _ (u8);
 166
 167 #undef _
 168
 169 static inline clib_error_t *
 170 vlib_pci_intr_enable(vlib_pci_device_t * dev)
 171 {
 172   u16 command;
 173   clib_error_t * err;
 174
 175   err = vlib_pci_read_config_u16(dev, 4, &command);
 176
 177   if (err)
 178     return err;
 179
 180   command &= ~PCI_COMMAND_INTX_DISABLE;
 181
 182   return vlib_pci_write_config_u16(dev, 4, &command);
 183 }
 184
 185 static inline clib_error_t *
 186 vlib_pci_intr_disable(vlib_pci_device_t * dev)
 187 {
 188   u16 command;
 189   clib_error_t * err;
 190
 191   err = vlib_pci_read_config_u16(dev, 4, &command);
 192
 193   if (err)
 194     return err;
 195
 196   command |= PCI_COMMAND_INTX_DISABLE;
 197
 198   return vlib_pci_write_config_u16(dev, 4, &command);
 199 }
 200
 201 static inline clib_error_t *
 202 vlib_pci_bus_master_enable(vlib_pci_device_t * dev)
 203 {
 204   clib_error_t * err;
 205   u16 command;
 206
 207   /* Set bus master enable (BME) */
 208   err = vlib_pci_read_config_u16(dev, 4, &command);
 209
 210   if (err)
 211     return err;
 212
 213   if (!(command & PCI_COMMAND_BUS_MASTER))
 214     return 0;
 215
 216   command |= PCI_COMMAND_BUS_MASTER;
 217
 218   return vlib_pci_write_config_u16(dev, 4, &command);
 219 }
 220
 221 clib_error_t *
 222 vlib_pci_map_resource (vlib_pci_device_t * dev, u32 resource, void ** result);
 223
 224 clib_error_t *
 225 vlib_pci_map_resource_fixed (vlib_pci_device_t * dev, u32 resource, u8 * addr,
 226                            void ** result);
 227
 228 /* Free's device. */
 229 void
 230 vlib_pci_free_device (vlib_pci_device_t * dev);
 231
 232 unformat_function_t unformat_vlib_pci_addr;
 233 format_function_t format_vlib_pci_addr;
 234 format_function_t format_vlib_pci_handle;
 235 format_function_t format_vlib_pci_link_speed;
 236
 237 #endif /* included_vlib_pci_h */