1 /* 2 * Broadcom PCI-SPI Host Controller Register Definitions 3 * 4 * Copyright (C) 2020, Broadcom. 5 * 6 * Unless you and Broadcom execute a separate written software license 7 * agreement governing use of this software, this software is licensed to you 8 * under the terms of the GNU General Public License version 2 (the "GPL"), 9 * available at http://www.broadcom.com/licenses/GPLv2.php, with the 10 * following added to such license: 11 * 12 * As a special exception, the copyright holders of this software give you 13 * permission to link this software with independent modules, and to copy and 14 * distribute the resulting executable under terms of your choice, provided that 15 * you also meet, for each linked independent module, the terms and conditions of 16 * the license of that module. An independent module is a module which is not 17 * derived from this software. The special exception does not apply to any 18 * modifications of the software. 19 * 20 * 21 * <<Broadcom-WL-IPTag/Dual:>> 22 */ 23 #ifndef _BCM_PCI_SPI_H 24 #define _BCM_PCI_SPI_H 25 26 /* cpp contortions to concatenate w/arg prescan */ 27 #ifndef PAD 28 #define _PADLINE(line) pad ## line 29 #define _XSTR(line) _PADLINE(line) 30 #define PAD _XSTR(__LINE__) 31 #endif /* PAD */ 32 33 /* 34 +---------------------------------------------------------------------------+ 35 | | 36 | 7 6 5 4 3 2 1 0 | 37 | 0x0000 SPI_CTRL SPIE SPE 0 MSTR CPOL CPHA SPR1 SPR0 | 38 | 0x0004 SPI_STAT SPIF WCOL ST1 ST0 WFFUL WFEMP RFFUL RFEMP | 39 | 0x0008 SPI_DATA Bits 31:0, data to send out on MOSI | 40 | 0x000C SPI_EXT ICNT1 ICNT0 BSWAP *HSMODE ESPR1 ESPR0 | 41 | 0x0020 GPIO_OE 0=input, 1=output PWR_OE CS_OE | 42 | 0x0024 GPIO_DATA CARD:1=missing, 0=present CARD PWR_DAT CS_DAT | 43 | 0x0040 INT_EDGE 0=level, 1=edge DEV_E SPI_E | 44 | 0x0044 INT_POL 1=active high, 0=active low DEV_P SPI_P | 45 | 0x0048 INTMASK DEV SPI | 46 | 0x004C INTSTATUS DEV SPI | 47 | 0x0060 HEXDISP Reset value: 0x14e443f5. In hexdisp mode, value | 48 | shows on the Raggedstone1 4-digit 7-segment display. | 49 | 0x0064 CURRENT_MA Low 16 bits indicate card current consumption in mA | 50 | 0x006C DISP_SEL Display mode (0=hexdisp, 1=current) DSP | 51 | 0x00C0 PLL_CTL bit31=ext_clk, remainder unused. | 52 | 0x00C4 PLL_STAT LOCK | 53 | 0x00C8 CLK_FREQ | 54 | 0x00CC CLK_CNT | 55 | | 56 | *Notes: HSMODE is not implemented, never set this bit! | 57 | BSWAP is available in rev >= 8 | 58 | | 59 +---------------------------------------------------------------------------+ 60 */ 61 62 typedef volatile struct { 63 uint32 spih_ctrl; /* 0x00 SPI Control Register */ 64 uint32 spih_stat; /* 0x04 SPI Status Register */ 65 uint32 spih_data; /* 0x08 SPI Data Register, 32-bits wide */ 66 uint32 spih_ext; /* 0x0C SPI Extension Register */ 67 uint32 PAD[4]; /* 0x10-0x1F PADDING */ 68 69 uint32 spih_gpio_ctrl; /* 0x20 SPI GPIO Control Register */ 70 uint32 spih_gpio_data; /* 0x24 SPI GPIO Data Register */ 71 uint32 PAD[6]; /* 0x28-0x3F PADDING */ 72 73 uint32 spih_int_edge; /* 0x40 SPI Interrupt Edge Register (0=Level, 1=Edge) */ 74 uint32 spih_int_pol; /* 0x44 SPI Interrupt Polarity Register (0=Active Low, */ 75 /* 1=Active High) */ 76 uint32 spih_int_mask; /* 0x48 SPI Interrupt Mask */ 77 uint32 spih_int_status; /* 0x4C SPI Interrupt Status */ 78 uint32 PAD[4]; /* 0x50-0x5F PADDING */ 79 80 uint32 spih_hex_disp; /* 0x60 SPI 4-digit hex display value */ 81 uint32 spih_current_ma; /* 0x64 SPI SD card current consumption in mA */ 82 uint32 PAD[1]; /* 0x68 PADDING */ 83 uint32 spih_disp_sel; /* 0x6c SPI 4-digit hex display mode select (1=current) */ 84 uint32 PAD[4]; /* 0x70-0x7F PADDING */ 85 uint32 PAD[8]; /* 0x80-0x9F PADDING */ 86 uint32 PAD[8]; /* 0xA0-0xBF PADDING */ 87 uint32 spih_pll_ctrl; /* 0xC0 PLL Control Register */ 88 uint32 spih_pll_status; /* 0xC4 PLL Status Register */ 89 uint32 spih_xtal_freq; /* 0xC8 External Clock Frequency in units of 10000Hz */ 90 uint32 spih_clk_count; /* 0xCC External Clock Count Register */ 91 92 } spih_regs_t; 93 94 typedef volatile struct { 95 uint32 cfg_space[0x40]; /* 0x000-0x0FF PCI Configuration Space (Read Only) */ 96 uint32 P_IMG_CTRL0; /* 0x100 PCI Image0 Control Register */ 97 98 uint32 P_BA0; /* 0x104 32 R/W PCI Image0 Base Address register */ 99 uint32 P_AM0; /* 0x108 32 R/W PCI Image0 Address Mask register */ 100 uint32 P_TA0; /* 0x10C 32 R/W PCI Image0 Translation Address register */ 101 uint32 P_IMG_CTRL1; /* 0x110 32 R/W PCI Image1 Control register */ 102 uint32 P_BA1; /* 0x114 32 R/W PCI Image1 Base Address register */ 103 uint32 P_AM1; /* 0x118 32 R/W PCI Image1 Address Mask register */ 104 uint32 P_TA1; /* 0x11C 32 R/W PCI Image1 Translation Address register */ 105 uint32 P_IMG_CTRL2; /* 0x120 32 R/W PCI Image2 Control register */ 106 uint32 P_BA2; /* 0x124 32 R/W PCI Image2 Base Address register */ 107 uint32 P_AM2; /* 0x128 32 R/W PCI Image2 Address Mask register */ 108 uint32 P_TA2; /* 0x12C 32 R/W PCI Image2 Translation Address register */ 109 uint32 P_IMG_CTRL3; /* 0x130 32 R/W PCI Image3 Control register */ 110 uint32 P_BA3; /* 0x134 32 R/W PCI Image3 Base Address register */ 111 uint32 P_AM3; /* 0x138 32 R/W PCI Image3 Address Mask register */ 112 uint32 P_TA3; /* 0x13C 32 R/W PCI Image3 Translation Address register */ 113 uint32 P_IMG_CTRL4; /* 0x140 32 R/W PCI Image4 Control register */ 114 uint32 P_BA4; /* 0x144 32 R/W PCI Image4 Base Address register */ 115 uint32 P_AM4; /* 0x148 32 R/W PCI Image4 Address Mask register */ 116 uint32 P_TA4; /* 0x14C 32 R/W PCI Image4 Translation Address register */ 117 uint32 P_IMG_CTRL5; /* 0x150 32 R/W PCI Image5 Control register */ 118 uint32 P_BA5; /* 0x154 32 R/W PCI Image5 Base Address register */ 119 uint32 P_AM5; /* 0x158 32 R/W PCI Image5 Address Mask register */ 120 uint32 P_TA5; /* 0x15C 32 R/W PCI Image5 Translation Address register */ 121 uint32 P_ERR_CS; /* 0x160 32 R/W PCI Error Control and Status register */ 122 uint32 P_ERR_ADDR; /* 0x164 32 R PCI Erroneous Address register */ 123 uint32 P_ERR_DATA; /* 0x168 32 R PCI Erroneous Data register */ 124 125 uint32 PAD[5]; /* 0x16C-0x17F PADDING */ 126 127 uint32 WB_CONF_SPC_BAR; /* 0x180 32 R WISHBONE Configuration Space Base Address */ 128 uint32 W_IMG_CTRL1; /* 0x184 32 R/W WISHBONE Image1 Control register */ 129 uint32 W_BA1; /* 0x188 32 R/W WISHBONE Image1 Base Address register */ 130 uint32 W_AM1; /* 0x18C 32 R/W WISHBONE Image1 Address Mask register */ 131 uint32 W_TA1; /* 0x190 32 R/W WISHBONE Image1 Translation Address reg */ 132 uint32 W_IMG_CTRL2; /* 0x194 32 R/W WISHBONE Image2 Control register */ 133 uint32 W_BA2; /* 0x198 32 R/W WISHBONE Image2 Base Address register */ 134 uint32 W_AM2; /* 0x19C 32 R/W WISHBONE Image2 Address Mask register */ 135 uint32 W_TA2; /* 0x1A0 32 R/W WISHBONE Image2 Translation Address reg */ 136 uint32 W_IMG_CTRL3; /* 0x1A4 32 R/W WISHBONE Image3 Control register */ 137 uint32 W_BA3; /* 0x1A8 32 R/W WISHBONE Image3 Base Address register */ 138 uint32 W_AM3; /* 0x1AC 32 R/W WISHBONE Image3 Address Mask register */ 139 uint32 W_TA3; /* 0x1B0 32 R/W WISHBONE Image3 Translation Address reg */ 140 uint32 W_IMG_CTRL4; /* 0x1B4 32 R/W WISHBONE Image4 Control register */ 141 uint32 W_BA4; /* 0x1B8 32 R/W WISHBONE Image4 Base Address register */ 142 uint32 W_AM4; /* 0x1BC 32 R/W WISHBONE Image4 Address Mask register */ 143 uint32 W_TA4; /* 0x1C0 32 R/W WISHBONE Image4 Translation Address reg */ 144 uint32 W_IMG_CTRL5; /* 0x1C4 32 R/W WISHBONE Image5 Control register */ 145 uint32 W_BA5; /* 0x1C8 32 R/W WISHBONE Image5 Base Address register */ 146 uint32 W_AM5; /* 0x1CC 32 R/W WISHBONE Image5 Address Mask register */ 147 uint32 W_TA5; /* 0x1D0 32 R/W WISHBONE Image5 Translation Address reg */ 148 uint32 W_ERR_CS; /* 0x1D4 32 R/W WISHBONE Error Control and Status reg */ 149 uint32 W_ERR_ADDR; /* 0x1D8 32 R WISHBONE Erroneous Address register */ 150 uint32 W_ERR_DATA; /* 0x1DC 32 R WISHBONE Erroneous Data register */ 151 uint32 CNF_ADDR; /* 0x1E0 32 R/W Configuration Cycle register */ 152 uint32 CNF_DATA; /* 0x1E4 32 R/W Configuration Cycle Generation Data reg */ 153 154 uint32 INT_ACK; /* 0x1E8 32 R Interrupt Acknowledge register */ 155 uint32 ICR; /* 0x1EC 32 R/W Interrupt Control register */ 156 uint32 ISR; /* 0x1F0 32 R/W Interrupt Status register */ 157 } spih_pciregs_t; 158 159 /* 160 * PCI Core interrupt enable and status bit definitions. 161 */ 162 163 /* PCI Core ICR Register bit definitions */ 164 #define PCI_INT_PROP_EN (1 << 0) /* Interrupt Propagation Enable */ 165 #define PCI_WB_ERR_INT_EN (1 << 1) /* Wishbone Error Interrupt Enable */ 166 #define PCI_PCI_ERR_INT_EN (1 << 2) /* PCI Error Interrupt Enable */ 167 #define PCI_PAR_ERR_INT_EN (1 << 3) /* Parity Error Interrupt Enable */ 168 #define PCI_SYS_ERR_INT_EN (1 << 4) /* System Error Interrupt Enable */ 169 #define PCI_SOFTWARE_RESET (1U << 31) /* Software reset of the PCI Core. */ 170 171 /* PCI Core ISR Register bit definitions */ 172 #define PCI_INT_PROP_ST (1 << 0) /* Interrupt Propagation Status */ 173 #define PCI_WB_ERR_INT_ST (1 << 1) /* Wishbone Error Interrupt Status */ 174 #define PCI_PCI_ERR_INT_ST (1 << 2) /* PCI Error Interrupt Status */ 175 #define PCI_PAR_ERR_INT_ST (1 << 3) /* Parity Error Interrupt Status */ 176 #define PCI_SYS_ERR_INT_ST (1 << 4) /* System Error Interrupt Status */ 177 178 /* Registers on the Wishbone bus */ 179 #define SPIH_CTLR_INTR (1 << 0) /* SPI Host Controller Core Interrupt */ 180 #define SPIH_DEV_INTR (1 << 1) /* SPI Device Interrupt */ 181 #define SPIH_WFIFO_INTR (1 << 2) /* SPI Tx FIFO Empty Intr (FPGA Rev >= 8) */ 182 183 /* GPIO Bit definitions */ 184 #define SPIH_CS (1 << 0) /* SPI Chip Select (active low) */ 185 #define SPIH_SLOT_POWER (1 << 1) /* SD Card Slot Power Enable */ 186 #define SPIH_CARD_DETECT (1 << 2) /* SD Card Detect */ 187 188 /* SPI Status Register Bit definitions */ 189 #define SPIH_STATE_MASK 0x30 /* SPI Transfer State Machine state mask */ 190 #define SPIH_STATE_SHIFT 4 /* SPI Transfer State Machine state shift */ 191 #define SPIH_WFFULL (1 << 3) /* SPI Write FIFO Full */ 192 #define SPIH_WFEMPTY (1 << 2) /* SPI Write FIFO Empty */ 193 #define SPIH_RFFULL (1 << 1) /* SPI Read FIFO Full */ 194 #define SPIH_RFEMPTY (1 << 0) /* SPI Read FIFO Empty */ 195 196 #define SPIH_EXT_CLK (1U << 31) /* Use External Clock as PLL Clock source. */ 197 198 #define SPIH_PLL_NO_CLK (1 << 1) /* Set to 1 if the PLL's input clock is lost. */ 199 #define SPIH_PLL_LOCKED (1 << 3) /* Set to 1 when the PLL is locked. */ 200 201 /* Spin bit loop bound check */ 202 #define SPI_SPIN_BOUND 0xf4240 /* 1 million */ 203 204 #endif /* _BCM_PCI_SPI_H */ 205