[mirror_ubuntu-eoan-kernel.git] / drivers / ipack / carriers / tpci200.h

/* SPDX-License-Identifier: GPL-2.0-only */
/**
 * tpci200.h
 *
 * driver for the carrier TEWS TPCI-200
 *
 * Copyright (C) 2009-2012 CERN (www.cern.ch)
 * Author: Nicolas Serafini, EIC2 SA
 * Author: Samuel Iglesias Gonsalvez <siglesias@igalia.com>
 */

#ifndef _TPCI200_H_
#define _TPCI200_H_

#include <linux/limits.h>
#include <linux/pci.h>
#include <linux/spinlock.h>
#include <linux/swab.h>
#include <linux/io.h>
#include <linux/ipack.h>

#define TPCI200_NB_SLOT               0x4
#define TPCI200_NB_BAR                0x6

#define TPCI200_VENDOR_ID             0x1498
#define TPCI200_DEVICE_ID             0x30C8
#define TPCI200_SUBVENDOR_ID          0x1498
#define TPCI200_SUBDEVICE_ID          0x300A

#define TPCI200_CFG_MEM_BAR           0
#define TPCI200_IP_INTERFACE_BAR      2
#define TPCI200_IO_ID_INT_SPACES_BAR  3
#define TPCI200_MEM16_SPACE_BAR       4
#define TPCI200_MEM8_SPACE_BAR        5

struct tpci200_regs {
	__le16	revision;
	/* writes to control should occur with the mutex held to protect
	 * read-modify-write operations */
	__le16  control[4];
	__le16	reset;
	__le16	status;
	u8	reserved[242];
} __packed;

#define TPCI200_IFACE_SIZE            0x100

#define TPCI200_IO_SPACE_OFF          0x0000
#define TPCI200_IO_SPACE_INTERVAL     0x0100
#define TPCI200_IO_SPACE_SIZE         0x0080
#define TPCI200_ID_SPACE_OFF          0x0080
#define TPCI200_ID_SPACE_INTERVAL     0x0100
#define TPCI200_ID_SPACE_SIZE         0x0040
#define TPCI200_INT_SPACE_OFF         0x00C0
#define TPCI200_INT_SPACE_INTERVAL    0x0100
#define TPCI200_INT_SPACE_SIZE        0x0040
#define TPCI200_IOIDINT_SIZE          0x0400

#define TPCI200_MEM8_SPACE_INTERVAL   0x00400000
#define TPCI200_MEM8_SPACE_SIZE       0x00400000
#define TPCI200_MEM16_SPACE_INTERVAL  0x00800000
#define TPCI200_MEM16_SPACE_SIZE      0x00800000

/* control field in tpci200_regs */
#define TPCI200_INT0_EN               0x0040
#define TPCI200_INT1_EN               0x0080
#define TPCI200_INT0_EDGE             0x0010
#define TPCI200_INT1_EDGE             0x0020
#define TPCI200_ERR_INT_EN            0x0008
#define TPCI200_TIME_INT_EN           0x0004
#define TPCI200_RECOVER_EN            0x0002
#define TPCI200_CLK32                 0x0001

/* reset field in tpci200_regs */
#define TPCI200_A_RESET               0x0001
#define TPCI200_B_RESET               0x0002
#define TPCI200_C_RESET               0x0004
#define TPCI200_D_RESET               0x0008

/* status field in tpci200_regs */
#define TPCI200_A_TIMEOUT             0x1000
#define TPCI200_B_TIMEOUT             0x2000
#define TPCI200_C_TIMEOUT             0x4000
#define TPCI200_D_TIMEOUT             0x8000

#define TPCI200_A_ERROR               0x0100
#define TPCI200_B_ERROR               0x0200
#define TPCI200_C_ERROR               0x0400
#define TPCI200_D_ERROR               0x0800

#define TPCI200_A_INT0                0x0001
#define TPCI200_A_INT1                0x0002
#define TPCI200_B_INT0                0x0004
#define TPCI200_B_INT1                0x0008
#define TPCI200_C_INT0                0x0010
#define TPCI200_C_INT1                0x0020
#define TPCI200_D_INT0                0x0040
#define TPCI200_D_INT1                0x0080

#define TPCI200_SLOT_INT_MASK         0x00FF

/* PCI Configuration registers. The PCI bridge is a PLX Technology PCI9030. */
#define LAS1_DESC		      0x2C
#define LAS2_DESC		      0x30

/* Bits in the LAS?_DESC registers */
#define LAS_BIT_BIGENDIAN	      24

#define VME_IOID_SPACE  "IOID"
#define VME_MEM_SPACE  "MEM"

/**
 * struct slot_irq - slot IRQ definition.
 * @vector	Vector number
 * @handler	Handler called when IRQ arrives
 * @arg		Handler argument
 *
 */
struct slot_irq {
	struct ipack_device *holder;
	int		vector;
	irqreturn_t	(*handler)(void *);
	void		*arg;
};

/**
 * struct tpci200_slot - data specific to the tpci200 slot.
 * @slot_id	Slot identification gived to external interface
 * @irq		Slot IRQ infos
 * @io_phys	IO physical base address register of the slot
 * @id_phys	ID physical base address register of the slot
 * @int_phys	INT physical base address register of the slot
 * @mem_phys	MEM physical base address register of the slot
 *
 */
struct tpci200_slot {
	struct slot_irq	    *irq;
};

/**
 * struct tpci200_infos - informations specific of the TPCI200 tpci200.
 * @pci_dev		PCI device
 * @interface_regs	Pointer to IP interface space (Bar 2)
 * @ioidint_space	Pointer to IP ID, IO and INT space (Bar 3)
 * @mem8_space		Pointer to MEM space (Bar 4)
 *
 */
struct tpci200_infos {
	struct pci_dev			*pdev;
	struct pci_device_id		*id_table;
	struct tpci200_regs __iomem	*interface_regs;
	void __iomem			*cfg_regs;
	struct ipack_bus_device		*ipack_bus;
};
struct tpci200_board {
	unsigned int		number;
	struct mutex		mutex;
	spinlock_t		regs_lock;
	struct tpci200_slot	*slots;
	struct tpci200_infos	*info;
	phys_addr_t             mod_mem[IPACK_SPACE_COUNT];
};

#endif /* _TPCI200_H_ */
Commit	Line	Data
b886d83c	1	/* SPDX-License-Identifier: GPL-2.0-only */
0eeca14f SIG	2	/**
	3	* tpci200.h
	4	*
	5	* driver for the carrier TEWS TPCI-200
76859725 SIG	6	*
	7	* Copyright (C) 2009-2012 CERN (www.cern.ch)
	8	* Author: Nicolas Serafini, EIC2 SA
	9	* Author: Samuel Iglesias Gonsalvez <siglesias@igalia.com>
0eeca14f SIG	10	*/
	11
	12	#ifndef _TPCI200_H_
	13	#define _TPCI200_H_
	14
0eeca14f SIG	15	#include <linux/limits.h>
	16	#include <linux/pci.h>
	17	#include <linux/spinlock.h>
0eeca14f SIG	18	#include <linux/swab.h>
0eeca14f SIG	19	#include <linux/io.h>
7dbce021	20	#include <linux/ipack.h>
0eeca14f	21
0eeca14f SIG	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
cea2f7cd	30	#define TPCI200_CFG_MEM_BAR 0
0eeca14f SIG	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
28086cbd	36	struct tpci200_regs {
7dd73b86	37	__le16 revision;
28086cbd JT	38	/* writes to control should occur with the mutex held to protect
28086cbd JT	39	* read-modify-write operations */
7dd73b86 JT	40	__le16 control[4];
	41	__le16 reset;
	42	__le16 status;
28086cbd JT	43	u8 reserved[242];
28086cbd JT	44	} __packed;
0eeca14f SIG	45
	46	#define TPCI200_IFACE_SIZE 0x100
	47
	48	#define TPCI200_IO_SPACE_OFF 0x0000
6114aeaa	49	#define TPCI200_IO_SPACE_INTERVAL 0x0100
0eeca14f SIG	50	#define TPCI200_IO_SPACE_SIZE 0x0080
0eeca14f SIG	51	#define TPCI200_ID_SPACE_OFF 0x0080
6114aeaa	52	#define TPCI200_ID_SPACE_INTERVAL 0x0100
0eeca14f SIG	53	#define TPCI200_ID_SPACE_SIZE 0x0040
0eeca14f SIG	54	#define TPCI200_INT_SPACE_OFF 0x00C0
6114aeaa	55	#define TPCI200_INT_SPACE_INTERVAL 0x0100
0eeca14f SIG	56	#define TPCI200_INT_SPACE_SIZE 0x0040
	57	#define TPCI200_IOIDINT_SIZE 0x0400
	58
6114aeaa JT	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
0eeca14f	63
28086cbd	64	/* control field in tpci200_regs */
0eeca14f SIG	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
28086cbd	74	/* reset field in tpci200_regs */
0eeca14f SIG	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
28086cbd	80	/* status field in tpci200_regs */
0eeca14f SIG	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
cea2f7cd JT	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
0eeca14f SIG	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
0eeca14f SIG	117	*
	118	*/
	119	struct slot_irq {
6f2c12ae	120	struct ipack_device *holder;
611b564d	121	int vector;
faa75c40	122	irqreturn_t (handler)(void );
611b564d	123	void *arg;
0eeca14f SIG	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
e4af9497	132	* @int_phys INT physical base address register of the slot
0eeca14f SIG	133	* @mem_phys MEM physical base address register of the slot
	134	*
	135	*/
	136	struct tpci200_slot {
bb29ab86	137	struct slot_irq *irq;
0eeca14f SIG	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)
0eeca14f SIG	146	*
	147	*/
	148	struct tpci200_infos {
	149	struct pci_dev *pdev;
	150	struct pci_device_id *id_table;
28086cbd	151	struct tpci200_regs __iomem *interface_regs;
cea2f7cd	152	void __iomem *cfg_regs;
ec440335	153	struct ipack_bus_device *ipack_bus;
0eeca14f SIG	154	};
0eeca14f SIG	155	struct tpci200_board {
0eeca14f SIG	156	unsigned int number;
0eeca14f SIG	157	struct mutex mutex;
487e0a60	158	spinlock_t regs_lock;
0eeca14f SIG	159	struct tpci200_slot *slots;
0eeca14f SIG	160	struct tpci200_infos *info;
84a08fa9	161	phys_addr_t mod_mem[IPACK_SPACE_COUNT];
0eeca14f SIG	162	};
	163
	164	#endif /* _TPCI200_H_ */