drivers/ipack/carriers/tpci200.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /**
   3  * tpci200.h
   4  *
   5  * driver for the carrier TEWS TPCI-200
   6  *
   7  * Copyright (C) 2009-2012 CERN (www.cern.ch)
   8  * Author: Nicolas Serafini, EIC2 SA
   9  * Author: Samuel Iglesias Gonsalvez <siglesias@igalia.com>
  10  */
  11
  12 #ifndef _TPCI200_H_
  13 #define _TPCI200_H_
  14
  15 #include <linux/limits.h>
  16 #include <linux/pci.h>
  17 #include <linux/spinlock.h>
  18 #include <linux/swab.h>
  19 #include <linux/io.h>
  20 #include <linux/ipack.h>
  21
  22 #define TPCI200_NB_SLOT               0x4
  23 #define TPCI200_NB_BAR                0x6
  24
  25 #define TPCI200_VENDOR_ID             0x1498
  26 #define TPCI200_DEVICE_ID             0x30C8
  27 #define TPCI200_SUBVENDOR_ID          0x1498
  28 #define TPCI200_SUBDEVICE_ID          0x300A
  29
  30 #define TPCI200_CFG_MEM_BAR           0
  31 #define TPCI200_IP_INTERFACE_BAR      2
  32 #define TPCI200_IO_ID_INT_SPACES_BAR  3
  33 #define TPCI200_MEM16_SPACE_BAR       4
  34 #define TPCI200_MEM8_SPACE_BAR        5
  35
  36 struct tpci200_regs {
  37         __le16  revision;
  38         /* writes to control should occur with the mutex held to protect
  39          * read-modify-write operations */
  40         __le16  control[4];
  41         __le16  reset;
  42         __le16  status;
  43         u8      reserved[242];
  44 } __packed;
  45
  46 #define TPCI200_IFACE_SIZE            0x100
  47
  48 #define TPCI200_IO_SPACE_OFF          0x0000
  49 #define TPCI200_IO_SPACE_INTERVAL     0x0100
  50 #define TPCI200_IO_SPACE_SIZE         0x0080
  51 #define TPCI200_ID_SPACE_OFF          0x0080
  52 #define TPCI200_ID_SPACE_INTERVAL     0x0100
  53 #define TPCI200_ID_SPACE_SIZE         0x0040
  54 #define TPCI200_INT_SPACE_OFF         0x00C0
  55 #define TPCI200_INT_SPACE_INTERVAL    0x0100
  56 #define TPCI200_INT_SPACE_SIZE        0x0040
  57 #define TPCI200_IOIDINT_SIZE          0x0400
  58
  59 #define TPCI200_MEM8_SPACE_INTERVAL   0x00400000
  60 #define TPCI200_MEM8_SPACE_SIZE       0x00400000
  61 #define TPCI200_MEM16_SPACE_INTERVAL  0x00800000
  62 #define TPCI200_MEM16_SPACE_SIZE      0x00800000
  63
  64 /* control field in tpci200_regs */
  65 #define TPCI200_INT0_EN               0x0040
  66 #define TPCI200_INT1_EN               0x0080
  67 #define TPCI200_INT0_EDGE             0x0010
  68 #define TPCI200_INT1_EDGE             0x0020
  69 #define TPCI200_ERR_INT_EN            0x0008
  70 #define TPCI200_TIME_INT_EN           0x0004
  71 #define TPCI200_RECOVER_EN            0x0002
  72 #define TPCI200_CLK32                 0x0001
  73
  74 /* reset field in tpci200_regs */
  75 #define TPCI200_A_RESET               0x0001
  76 #define TPCI200_B_RESET               0x0002
  77 #define TPCI200_C_RESET               0x0004
  78 #define TPCI200_D_RESET               0x0008
  79
  80 /* status field in tpci200_regs */
  81 #define TPCI200_A_TIMEOUT             0x1000
  82 #define TPCI200_B_TIMEOUT             0x2000
  83 #define TPCI200_C_TIMEOUT             0x4000
  84 #define TPCI200_D_TIMEOUT             0x8000
  85
  86 #define TPCI200_A_ERROR               0x0100
  87 #define TPCI200_B_ERROR               0x0200
  88 #define TPCI200_C_ERROR               0x0400
  89 #define TPCI200_D_ERROR               0x0800
  90
  91 #define TPCI200_A_INT0                0x0001
  92 #define TPCI200_A_INT1                0x0002
  93 #define TPCI200_B_INT0                0x0004
  94 #define TPCI200_B_INT1                0x0008
  95 #define TPCI200_C_INT0                0x0010
  96 #define TPCI200_C_INT1                0x0020
  97 #define TPCI200_D_INT0                0x0040
  98 #define TPCI200_D_INT1                0x0080
  99
 100 #define TPCI200_SLOT_INT_MASK         0x00FF
 101
 102 /* PCI Configuration registers. The PCI bridge is a PLX Technology PCI9030. */
 103 #define LAS1_DESC                     0x2C
 104 #define LAS2_DESC                     0x30
 105
 106 /* Bits in the LAS?_DESC registers */
 107 #define LAS_BIT_BIGENDIAN             24
 108
 109 #define VME_IOID_SPACE  "IOID"
 110 #define VME_MEM_SPACE  "MEM"
 111
 112 /**
 113  * struct slot_irq - slot IRQ definition.
 114  * @vector      Vector number
 115  * @handler     Handler called when IRQ arrives
 116  * @arg         Handler argument
 117  *
 118  */
 119 struct slot_irq {
 120         struct ipack_device *holder;
 121         int             vector;
 122         irqreturn_t     (*handler)(void *);
 123         void            *arg;
 124 };
 125
 126 /**
 127  * struct tpci200_slot - data specific to the tpci200 slot.
 128  * @slot_id     Slot identification gived to external interface
 129  * @irq         Slot IRQ infos
 130  * @io_phys     IO physical base address register of the slot
 131  * @id_phys     ID physical base address register of the slot
 132  * @int_phys    INT physical base address register of the slot
 133  * @mem_phys    MEM physical base address register of the slot
 134  *
 135  */
 136 struct tpci200_slot {
 137         struct slot_irq     *irq;
 138 };
 139
 140 /**
 141  * struct tpci200_infos - informations specific of the TPCI200 tpci200.
 142  * @pci_dev             PCI device
 143  * @interface_regs      Pointer to IP interface space (Bar 2)
 144  * @ioidint_space       Pointer to IP ID, IO and INT space (Bar 3)
 145  * @mem8_space          Pointer to MEM space (Bar 4)
 146  *
 147  */
 148 struct tpci200_infos {
 149         struct pci_dev                  *pdev;
 150         struct pci_device_id            *id_table;
 151         struct tpci200_regs __iomem     *interface_regs;
 152         void __iomem                    *cfg_regs;
 153         struct ipack_bus_device         *ipack_bus;
 154 };
 155 struct tpci200_board {
 156         unsigned int            number;
 157         struct mutex            mutex;
 158         spinlock_t              regs_lock;
 159         struct tpci200_slot     *slots;
 160         struct tpci200_infos    *info;
 161         phys_addr_t             mod_mem[IPACK_SPACE_COUNT];
 162 };
 163
 164 #endif /* _TPCI200_H_ */