drivers/xen/xen-pciback/conf_space.c

   1 /*
   2  * PCI Backend - Functions for creating a virtual configuration space for
   3  *               exported PCI Devices.
   4  *               It's dangerous to allow PCI Driver Domains to change their
   5  *               device's resources (memory, i/o ports, interrupts). We need to
   6  *               restrict changes to certain PCI Configuration registers:
   7  *               BARs, INTERRUPT_PIN, most registers in the header...
   8  *
   9  * Author: Ryan Wilson <hap9@epoch.ncsc.mil>
  10  */
  11
  12 #include <linux/kernel.h>
  13 #include <linux/moduleparam.h>
  14 #include <linux/pci.h>
  15 #include "pciback.h"
  16 #include "conf_space.h"
  17 #include "conf_space_quirks.h"
  18
  19 bool xen_pcibk_permissive;
  20 module_param_named(permissive, xen_pcibk_permissive, bool, 0644);
  21
  22 /* This is where xen_pcibk_read_config_byte, xen_pcibk_read_config_word,
  23  * xen_pcibk_write_config_word, and xen_pcibk_write_config_byte are created. */
  24 #define DEFINE_PCI_CONFIG(op, size, type)                       \
  25 int xen_pcibk_##op##_config_##size                              \
  26 (struct pci_dev *dev, int offset, type value, void *data)       \
  27 {                                                               \
  28         return pci_##op##_config_##size(dev, offset, value);    \
  29 }
  30
  31 DEFINE_PCI_CONFIG(read, byte, u8 *)
  32 DEFINE_PCI_CONFIG(read, word, u16 *)
  33 DEFINE_PCI_CONFIG(read, dword, u32 *)
  34
  35 DEFINE_PCI_CONFIG(write, byte, u8)
  36 DEFINE_PCI_CONFIG(write, word, u16)
  37 DEFINE_PCI_CONFIG(write, dword, u32)
  38
  39 static int conf_space_read(struct pci_dev *dev,
  40                            const struct config_field_entry *entry,
  41                            int offset, u32 *value)
  42 {
  43         int ret = 0;
  44         const struct config_field *field = entry->field;
  45
  46         *value = 0;
  47
  48         switch (field->size) {
  49         case 1:
  50                 if (field->u.b.read)
  51                         ret = field->u.b.read(dev, offset, (u8 *) value,
  52                                               entry->data);
  53                 break;
  54         case 2:
  55                 if (field->u.w.read)
  56                         ret = field->u.w.read(dev, offset, (u16 *) value,
  57                                               entry->data);
  58                 break;
  59         case 4:
  60                 if (field->u.dw.read)
  61                         ret = field->u.dw.read(dev, offset, value, entry->data);
  62                 break;
  63         }
  64         return ret;
  65 }
  66
  67 static int conf_space_write(struct pci_dev *dev,
  68                             const struct config_field_entry *entry,
  69                             int offset, u32 value)
  70 {
  71         int ret = 0;
  72         const struct config_field *field = entry->field;
  73
  74         switch (field->size) {
  75         case 1:
  76                 if (field->u.b.write)
  77                         ret = field->u.b.write(dev, offset, (u8) value,
  78                                                entry->data);
  79                 break;
  80         case 2:
  81                 if (field->u.w.write)
  82                         ret = field->u.w.write(dev, offset, (u16) value,
  83                                                entry->data);
  84                 break;
  85         case 4:
  86                 if (field->u.dw.write)
  87                         ret = field->u.dw.write(dev, offset, value,
  88                                                 entry->data);
  89                 break;
  90         }
  91         return ret;
  92 }
  93
  94 static inline u32 get_mask(int size)
  95 {
  96         if (size == 1)
  97                 return 0xff;
  98         else if (size == 2)
  99                 return 0xffff;
 100         else
 101                 return 0xffffffff;
 102 }
 103
 104 static inline int valid_request(int offset, int size)
 105 {
 106         /* Validate request (no un-aligned requests) */
 107         if ((size == 1 || size == 2 || size == 4) && (offset % size) == 0)
 108                 return 1;
 109         return 0;
 110 }
 111
 112 static inline u32 merge_value(u32 val, u32 new_val, u32 new_val_mask,
 113                               int offset)
 114 {
 115         if (offset >= 0) {
 116                 new_val_mask <<= (offset * 8);
 117                 new_val <<= (offset * 8);
 118         } else {
 119                 new_val_mask >>= (offset * -8);
 120                 new_val >>= (offset * -8);
 121         }
 122         val = (val & ~new_val_mask) | (new_val & new_val_mask);
 123
 124         return val;
 125 }
 126
 127 static int xen_pcibios_err_to_errno(int err)
 128 {
 129         switch (err) {
 130         case PCIBIOS_SUCCESSFUL:
 131                 return XEN_PCI_ERR_success;
 132         case PCIBIOS_DEVICE_NOT_FOUND:
 133                 return XEN_PCI_ERR_dev_not_found;
 134         case PCIBIOS_BAD_REGISTER_NUMBER:
 135                 return XEN_PCI_ERR_invalid_offset;
 136         case PCIBIOS_FUNC_NOT_SUPPORTED:
 137                 return XEN_PCI_ERR_not_implemented;
 138         case PCIBIOS_SET_FAILED:
 139                 return XEN_PCI_ERR_access_denied;
 140         }
 141         return err;
 142 }
 143
 144 int xen_pcibk_config_read(struct pci_dev *dev, int offset, int size,
 145                           u32 *ret_val)
 146 {
 147         int err = 0;
 148         struct xen_pcibk_dev_data *dev_data = pci_get_drvdata(dev);
 149         const struct config_field_entry *cfg_entry;
 150         const struct config_field *field;
 151         int req_start, req_end, field_start, field_end;
 152         /* if read fails for any reason, return 0
 153          * (as if device didn't respond) */
 154         u32 value = 0, tmp_val;
 155
 156         if (unlikely(verbose_request))
 157                 printk(KERN_DEBUG DRV_NAME ": %s: read %d bytes at 0x%x\n",
 158                        pci_name(dev), size, offset);
 159
 160         if (!valid_request(offset, size)) {
 161                 err = XEN_PCI_ERR_invalid_offset;
 162                 goto out;
 163         }
 164
 165         /* Get the real value first, then modify as appropriate */
 166         switch (size) {
 167         case 1:
 168                 err = pci_read_config_byte(dev, offset, (u8 *) &value);
 169                 break;
 170         case 2:
 171                 err = pci_read_config_word(dev, offset, (u16 *) &value);
 172                 break;
 173         case 4:
 174                 err = pci_read_config_dword(dev, offset, &value);
 175                 break;
 176         }
 177
 178         list_for_each_entry(cfg_entry, &dev_data->config_fields, list) {
 179                 field = cfg_entry->field;
 180
 181                 req_start = offset;
 182                 req_end = offset + size;
 183                 field_start = OFFSET(cfg_entry);
 184                 field_end = OFFSET(cfg_entry) + field->size;
 185
 186                  if (req_end > field_start && field_end > req_start) {
 187                         err = conf_space_read(dev, cfg_entry, field_start,
 188                                               &tmp_val);
 189                         if (err)
 190                                 goto out;
 191
 192                         value = merge_value(value, tmp_val,
 193                                             get_mask(field->size),
 194                                             field_start - req_start);
 195                 }
 196         }
 197
 198 out:
 199         if (unlikely(verbose_request))
 200                 printk(KERN_DEBUG DRV_NAME ": %s: read %d bytes at 0x%x = %x\n",
 201                        pci_name(dev), size, offset, value);
 202
 203         *ret_val = value;
 204         return xen_pcibios_err_to_errno(err);
 205 }
 206
 207 int xen_pcibk_config_write(struct pci_dev *dev, int offset, int size, u32 value)
 208 {
 209         int err = 0, handled = 0;
 210         struct xen_pcibk_dev_data *dev_data = pci_get_drvdata(dev);
 211         const struct config_field_entry *cfg_entry;
 212         const struct config_field *field;
 213         u32 tmp_val;
 214         int req_start, req_end, field_start, field_end;
 215
 216         if (unlikely(verbose_request))
 217                 printk(KERN_DEBUG
 218                        DRV_NAME ": %s: write request %d bytes at 0x%x = %x\n",
 219                        pci_name(dev), size, offset, value);
 220
 221         if (!valid_request(offset, size))
 222                 return XEN_PCI_ERR_invalid_offset;
 223
 224         list_for_each_entry(cfg_entry, &dev_data->config_fields, list) {
 225                 field = cfg_entry->field;
 226
 227                 req_start = offset;
 228                 req_end = offset + size;
 229                 field_start = OFFSET(cfg_entry);
 230                 field_end = OFFSET(cfg_entry) + field->size;
 231
 232                  if (req_end > field_start && field_end > req_start) {
 233                         err = conf_space_read(dev, cfg_entry, field_start,
 234                                               &tmp_val);
 235                         if (err)
 236                                 break;
 237
 238                         tmp_val = merge_value(tmp_val, value, get_mask(size),
 239                                               req_start - field_start);
 240
 241                         err = conf_space_write(dev, cfg_entry, field_start,
 242                                                tmp_val);
 243
 244                         /* handled is set true here, but not every byte
 245                          * may have been written! Properly detecting if
 246                          * every byte is handled is unnecessary as the
 247                          * flag is used to detect devices that need
 248                          * special helpers to work correctly.
 249                          */
 250                         handled = 1;
 251                 }
 252         }
 253
 254         if (!handled && !err) {
 255                 /* By default, anything not specificially handled above is
 256                  * read-only. The permissive flag changes this behavior so
 257                  * that anything not specifically handled above is writable.
 258                  * This means that some fields may still be read-only because
 259                  * they have entries in the config_field list that intercept
 260                  * the write and do nothing. */
 261                 if (dev_data->permissive || xen_pcibk_permissive) {
 262                         switch (size) {
 263                         case 1:
 264                                 err = pci_write_config_byte(dev, offset,
 265                                                             (u8) value);
 266                                 break;
 267                         case 2:
 268                                 err = pci_write_config_word(dev, offset,
 269                                                             (u16) value);
 270                                 break;
 271                         case 4:
 272                                 err = pci_write_config_dword(dev, offset,
 273                                                              (u32) value);
 274                                 break;
 275                         }
 276                 } else if (!dev_data->warned_on_write) {
 277                         dev_data->warned_on_write = 1;
 278                         dev_warn(&dev->dev, "Driver tried to write to a "
 279                                  "read-only configuration space field at offset"
 280                                  " 0x%x, size %d. This may be harmless, but if "
 281                                  "you have problems with your device:\n"
 282                                  "1) see permissive attribute in sysfs\n"
 283                                  "2) report problems to the xen-devel "
 284                                  "mailing list along with details of your "
 285                                  "device obtained from lspci.\n", offset, size);
 286                 }
 287         }
 288
 289         return xen_pcibios_err_to_errno(err);
 290 }
 291
 292 void xen_pcibk_config_free_dyn_fields(struct pci_dev *dev)
 293 {
 294         struct xen_pcibk_dev_data *dev_data = pci_get_drvdata(dev);
 295         struct config_field_entry *cfg_entry, *t;
 296         const struct config_field *field;
 297
 298         dev_dbg(&dev->dev, "free-ing dynamically allocated virtual "
 299                            "configuration space fields\n");
 300         if (!dev_data)
 301                 return;
 302
 303         list_for_each_entry_safe(cfg_entry, t, &dev_data->config_fields, list) {
 304                 field = cfg_entry->field;
 305
 306                 if (field->clean) {
 307                         field->clean((struct config_field *)field);
 308
 309                         kfree(cfg_entry->data);
 310
 311                         list_del(&cfg_entry->list);
 312                         kfree(cfg_entry);
 313                 }
 314
 315         }
 316 }
 317
 318 void xen_pcibk_config_reset_dev(struct pci_dev *dev)
 319 {
 320         struct xen_pcibk_dev_data *dev_data = pci_get_drvdata(dev);
 321         const struct config_field_entry *cfg_entry;
 322         const struct config_field *field;
 323
 324         dev_dbg(&dev->dev, "resetting virtual configuration space\n");
 325         if (!dev_data)
 326                 return;
 327
 328         list_for_each_entry(cfg_entry, &dev_data->config_fields, list) {
 329                 field = cfg_entry->field;
 330
 331                 if (field->reset)
 332                         field->reset(dev, OFFSET(cfg_entry), cfg_entry->data);
 333         }
 334 }
 335
 336 void xen_pcibk_config_free_dev(struct pci_dev *dev)
 337 {
 338         struct xen_pcibk_dev_data *dev_data = pci_get_drvdata(dev);
 339         struct config_field_entry *cfg_entry, *t;
 340         const struct config_field *field;
 341
 342         dev_dbg(&dev->dev, "free-ing virtual configuration space fields\n");
 343         if (!dev_data)
 344                 return;
 345
 346         list_for_each_entry_safe(cfg_entry, t, &dev_data->config_fields, list) {
 347                 list_del(&cfg_entry->list);
 348
 349                 field = cfg_entry->field;
 350
 351                 if (field->release)
 352                         field->release(dev, OFFSET(cfg_entry), cfg_entry->data);
 353
 354                 kfree(cfg_entry);
 355         }
 356 }
 357
 358 int xen_pcibk_config_add_field_offset(struct pci_dev *dev,
 359                                     const struct config_field *field,
 360                                     unsigned int base_offset)
 361 {
 362         int err = 0;
 363         struct xen_pcibk_dev_data *dev_data = pci_get_drvdata(dev);
 364         struct config_field_entry *cfg_entry;
 365         void *tmp;
 366
 367         cfg_entry = kmalloc(sizeof(*cfg_entry), GFP_KERNEL);
 368         if (!cfg_entry) {
 369                 err = -ENOMEM;
 370                 goto out;
 371         }
 372
 373         cfg_entry->data = NULL;
 374         cfg_entry->field = field;
 375         cfg_entry->base_offset = base_offset;
 376
 377         /* silently ignore duplicate fields */
 378         err = xen_pcibk_field_is_dup(dev, OFFSET(cfg_entry));
 379         if (err)
 380                 goto out;
 381
 382         if (field->init) {
 383                 tmp = field->init(dev, OFFSET(cfg_entry));
 384
 385                 if (IS_ERR(tmp)) {
 386                         err = PTR_ERR(tmp);
 387                         goto out;
 388                 }
 389
 390                 cfg_entry->data = tmp;
 391         }
 392
 393         dev_dbg(&dev->dev, "added config field at offset 0x%02x\n",
 394                 OFFSET(cfg_entry));
 395         list_add_tail(&cfg_entry->list, &dev_data->config_fields);
 396
 397 out:
 398         if (err)
 399                 kfree(cfg_entry);
 400
 401         return err;
 402 }
 403
 404 /* This sets up the device's virtual configuration space to keep track of
 405  * certain registers (like the base address registers (BARs) so that we can
 406  * keep the client from manipulating them directly.
 407  */
 408 int xen_pcibk_config_init_dev(struct pci_dev *dev)
 409 {
 410         int err = 0;
 411         struct xen_pcibk_dev_data *dev_data = pci_get_drvdata(dev);
 412
 413         dev_dbg(&dev->dev, "initializing virtual configuration space\n");
 414
 415         INIT_LIST_HEAD(&dev_data->config_fields);
 416
 417         err = xen_pcibk_config_header_add_fields(dev);
 418         if (err)
 419                 goto out;
 420
 421         err = xen_pcibk_config_capability_add_fields(dev);
 422         if (err)
 423                 goto out;
 424
 425         err = xen_pcibk_config_quirks_init(dev);
 426
 427 out:
 428         return err;
 429 }
 430
 431 int xen_pcibk_config_init(void)
 432 {
 433         return xen_pcibk_config_capability_init();
 434 }