vlib/vlib/unix/pci.h

   1 /*
   2  * Copyright (c) 2015 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  * unix/pci.h: Linux specific pci state
  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_unix_pci_h
  41 #define included_unix_pci_h
  42
  43 #include <vlib/pci/pci.h>
  44
  45 typedef struct {
  46   /* /sys/bus/pci/devices/... directory name for this device. */
  47   u8 * dev_dir_name;
  48
  49   /* Resource file descriptors. */
  50   int * resource_fds;
  51
  52   /* File descriptor for config space read/write. */
  53   int config_fd;
  54
  55   /* PCI bus address for this devices parsed from /sys/bus/pci/devices name. */
  56   pci_bus_address_t bus_address;
  57
  58   /* File descriptor for /dev/uio%d */
  59   int uio_fd;
  60
  61   /* Minor device for uio device. */
  62   u32 uio_minor;
  63
  64   /* Index given by unix_file_add. */
  65   u32 unix_file_index;
  66
  67   /* Input node to handle interrupts for this device. */
  68   u32 device_input_node_index;
  69
  70   /* Node runtime will be a bitmap of device indices with pending interrupts. */
  71   u32 device_index;
  72 } linux_pci_device_t;
  73
  74 /* Pool of PCI devices. */
  75 typedef struct {
  76   vlib_main_t * vlib_main;
  77   linux_pci_device_t * pci_devices;
  78 } linux_pci_main_t;
  79
  80 extern linux_pci_main_t linux_pci_main;
  81
  82 always_inline linux_pci_device_t *
  83 pci_dev_for_linux (pci_device_t * dev)
  84 {
  85   linux_pci_main_t * pm = &linux_pci_main;
  86   return pool_elt_at_index (pm->pci_devices, dev->os_handle);
  87 }
  88
  89 /* Call to allocate/initialize the pci subsystem.
  90    This is not an init function so that users can explicitly enable
  91    pci only when it's needed. */
  92 clib_error_t * pci_bus_init (vlib_main_t * vm);
  93
  94 #endif /* included_unix_pci_h */