1/*- 2 * Copyright (c) 2003 Hidetoshi Shimokawa 3 * Copyright (c) 1998-2002 Katsushi Kobayashi and Hidetoshi Shimokawa 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. All advertising materials mentioning features or use of this software 15 * must display the acknowledgement as bellow: 16 * 17 * This product includes software developed by K. Kobayashi and H. Shimokawa 18 * 19 * 4. The name of the author may not be used to endorse or promote products 20 * derived from this software without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 24 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 25 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, 26 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 27 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 30 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32 * POSSIBILITY OF SUCH DAMAGE. 33 * 34 * $FreeBSD: stable/11/sys/dev/firewire/fwohcireg.h 332156 2018-04-06 21:50:09Z kevans $ 35 * 36 */ 37#define PCI_CBMEM PCIR_BAR(0) 38 39#define FW_VENDORID_NATSEMI 0x100B 40#define FW_VENDORID_NEC 0x1033 41#define FW_VENDORID_SIS 0x1039 42#define FW_VENDORID_TI 0x104c 43#define FW_VENDORID_SONY 0x104d 44#define FW_VENDORID_VIA 0x1106 45#define FW_VENDORID_RICOH 0x1180 46#define FW_VENDORID_APPLE 0x106b 47#define FW_VENDORID_LUCENT 0x11c1 48#define FW_VENDORID_INTEL 0x8086 49#define FW_VENDORID_ADAPTEC 0x9004 50#define FW_VENDORID_SUN 0x108e 51 52#define FW_DEVICE_CS4210 (0x000f << 16) 53#define FW_DEVICE_UPD861 (0x0063 << 16) 54#define FW_DEVICE_UPD871 (0x00ce << 16) 55#define FW_DEVICE_UPD72870 (0x00cd << 16) 56#define FW_DEVICE_UPD72873 (0x00e7 << 16) 57#define FW_DEVICE_UPD72874 (0x00f2 << 16) 58#define FW_DEVICE_TITSB22 (0x8009 << 16) 59#define FW_DEVICE_TITSB23 (0x8019 << 16) 60#define FW_DEVICE_TITSB26 (0x8020 << 16) 61#define FW_DEVICE_TITSB43 (0x8021 << 16) 62#define FW_DEVICE_TITSB43A (0x8023 << 16) 63#define FW_DEVICE_TITSB43AB23 (0x8024 << 16) 64#define FW_DEVICE_TITSB82AA2 (0x8025 << 16) 65#define FW_DEVICE_TITSB43AB21 (0x8026 << 16) 66#define FW_DEVICE_TIPCI4410A (0x8017 << 16) 67#define FW_DEVICE_TIPCI4450 (0x8011 << 16) 68#define FW_DEVICE_TIPCI4451 (0x8027 << 16) 69#define FW_DEVICE_CXD1947 (0x8009 << 16) 70#define FW_DEVICE_CXD3222 (0x8039 << 16) 71#define FW_DEVICE_VT6306 (0x3044 << 16) 72#define FW_DEVICE_R5C551 (0x0551 << 16) 73#define FW_DEVICE_R5C552 (0x0552 << 16) 74#define FW_DEVICE_PANGEA (0x0030 << 16) 75#define FW_DEVICE_UNINORTH2 (0x0031 << 16) 76#define FW_DEVICE_AIC5800 (0x5800 << 16) 77#define FW_DEVICE_FW322 (0x5811 << 16) 78#define FW_DEVICE_7007 (0x7007 << 16) 79#define FW_DEVICE_82372FB (0x7605 << 16) 80#define FW_DEVICE_PCIO2FW (0x1102 << 16) 81 82#define PCI_INTERFACE_OHCI 0x10 83 84#define FW_OHCI_BASE_REG 0x10 85 86#define OHCI_DMA_ITCH 0x20 87#define OHCI_DMA_IRCH 0x20 88 89#define OHCI_MAX_DMA_CH (0x4 + OHCI_DMA_ITCH + OHCI_DMA_IRCH) 90 91 92typedef uint32_t fwohcireg_t; 93 94/* for PCI */ 95#if BYTE_ORDER == BIG_ENDIAN 96#define FWOHCI_DMA_WRITE(x, y) ((x) = htole32(y)) 97#define FWOHCI_DMA_READ(x) le32toh(x) 98#define FWOHCI_DMA_SET(x, y) ((x) |= htole32(y)) 99#define FWOHCI_DMA_CLEAR(x, y) ((x) &= htole32(~(y))) 100#else 101#define FWOHCI_DMA_WRITE(x, y) ((x) = (y)) 102#define FWOHCI_DMA_READ(x) (x) 103#define FWOHCI_DMA_SET(x, y) ((x) |= (y)) 104#define FWOHCI_DMA_CLEAR(x, y) ((x) &= ~(y)) 105#endif 106 107struct fwohcidb { 108 union { 109 struct { 110 uint32_t cmd; 111 uint32_t addr; 112 uint32_t depend; 113 uint32_t res; 114 } desc; 115 uint32_t immed[4]; 116 } db; 117#define OHCI_STATUS_SHIFT 16 118#define OHCI_COUNT_MASK 0xffff 119#define OHCI_OUTPUT_MORE (0 << 28) 120#define OHCI_OUTPUT_LAST (1 << 28) 121#define OHCI_INPUT_MORE (2 << 28) 122#define OHCI_INPUT_LAST (3 << 28) 123#define OHCI_STORE_QUAD (4 << 28) 124#define OHCI_LOAD_QUAD (5 << 28) 125#define OHCI_NOP (6 << 28) 126#define OHCI_STOP (7 << 28) 127#define OHCI_STORE (8 << 28) 128#define OHCI_CMD_MASK (0xf << 28) 129 130#define OHCI_UPDATE (1 << 27) 131 132#define OHCI_KEY_ST0 (0 << 24) 133#define OHCI_KEY_ST1 (1 << 24) 134#define OHCI_KEY_ST2 (2 << 24) 135#define OHCI_KEY_ST3 (3 << 24) 136#define OHCI_KEY_REGS (5 << 24) 137#define OHCI_KEY_SYS (6 << 24) 138#define OHCI_KEY_DEVICE (7 << 24) 139#define OHCI_KEY_MASK (7 << 24) 140 141#define OHCI_INTERRUPT_NEVER (0 << 20) 142#define OHCI_INTERRUPT_TRUE (1 << 20) 143#define OHCI_INTERRUPT_FALSE (2 << 20) 144#define OHCI_INTERRUPT_ALWAYS (3 << 20) 145 146#define OHCI_BRANCH_NEVER (0 << 18) 147#define OHCI_BRANCH_TRUE (1 << 18) 148#define OHCI_BRANCH_FALSE (2 << 18) 149#define OHCI_BRANCH_ALWAYS (3 << 18) 150#define OHCI_BRANCH_MASK (3 << 18) 151 152#define OHCI_WAIT_NEVER (0 << 16) 153#define OHCI_WAIT_TRUE (1 << 16) 154#define OHCI_WAIT_FALSE (2 << 16) 155#define OHCI_WAIT_ALWAYS (3 << 16) 156}; 157 158#define OHCI_SPD_S100 0x4 159#define OHCI_SPD_S200 0x1 160#define OHCI_SPD_S400 0x2 161 162 163#define FWOHCIEV_NOSTAT 0 164#define FWOHCIEV_LONGP 2 165#define FWOHCIEV_MISSACK 3 166#define FWOHCIEV_UNDRRUN 4 167#define FWOHCIEV_OVRRUN 5 168#define FWOHCIEV_DESCERR 6 169#define FWOHCIEV_DTRDERR 7 170#define FWOHCIEV_DTWRERR 8 171#define FWOHCIEV_BUSRST 9 172#define FWOHCIEV_TIMEOUT 0xa 173#define FWOHCIEV_TCODERR 0xb 174#define FWOHCIEV_UNKNOWN 0xe 175#define FWOHCIEV_FLUSHED 0xf 176#define FWOHCIEV_ACKCOMPL 0x11 177#define FWOHCIEV_ACKPEND 0x12 178#define FWOHCIEV_ACKBSX 0x14 179#define FWOHCIEV_ACKBSA 0x15 180#define FWOHCIEV_ACKBSB 0x16 181#define FWOHCIEV_ACKTARD 0x1b 182#define FWOHCIEV_ACKDERR 0x1d 183#define FWOHCIEV_ACKTERR 0x1e 184 185#define FWOHCIEV_MASK 0x1f 186 187struct ohci_dma { 188 fwohcireg_t cntl; 189 190#define OHCI_CNTL_CYCMATCH_S (0x1 << 31) 191 192#define OHCI_CNTL_BUFFIL (0x1 << 31) 193#define OHCI_CNTL_ISOHDR (0x1 << 30) 194#define OHCI_CNTL_CYCMATCH_R (0x1 << 29) 195#define OHCI_CNTL_MULTICH (0x1 << 28) 196 197#define OHCI_CNTL_DMA_RUN (0x1 << 15) 198#define OHCI_CNTL_DMA_WAKE (0x1 << 12) 199#define OHCI_CNTL_DMA_DEAD (0x1 << 11) 200#define OHCI_CNTL_DMA_ACTIVE (0x1 << 10) 201#define OHCI_CNTL_DMA_BT (0x1 << 8) 202#define OHCI_CNTL_DMA_BAD (0x1 << 7) 203#define OHCI_CNTL_DMA_STAT (0xff) 204 205 fwohcireg_t cntl_clr; 206 fwohcireg_t dummy0; 207 fwohcireg_t cmd; 208 fwohcireg_t match; 209 fwohcireg_t dummy1; 210 fwohcireg_t dummy2; 211 fwohcireg_t dummy3; 212}; 213 214struct ohci_itdma { 215 fwohcireg_t cntl; 216 fwohcireg_t cntl_clr; 217 fwohcireg_t dummy0; 218 fwohcireg_t cmd; 219}; 220 221struct ohci_registers { 222 fwohcireg_t ver; /* Version No. 0x0 */ 223 fwohcireg_t guid; /* GUID_ROM No. 0x4 */ 224 fwohcireg_t retry; /* AT retries 0x8 */ 225#define FWOHCI_RETRY 0x8 226 fwohcireg_t csr_data; /* CSR data 0xc */ 227 fwohcireg_t csr_cmp; /* CSR compare 0x10 */ 228 fwohcireg_t csr_cntl; /* CSR compare 0x14 */ 229 fwohcireg_t rom_hdr; /* config ROM ptr. 0x18 */ 230 fwohcireg_t bus_id; /* BUS_ID 0x1c */ 231 fwohcireg_t bus_opt; /* BUS option 0x20 */ 232#define FWOHCIGUID_H 0x24 233#define FWOHCIGUID_L 0x28 234 fwohcireg_t guid_hi; /* GUID hi 0x24 */ 235 fwohcireg_t guid_lo; /* GUID lo 0x28 */ 236 fwohcireg_t dummy0[2]; /* dummy 0x2c-0x30 */ 237 fwohcireg_t config_rom; /* config ROM map 0x34 */ 238 fwohcireg_t post_wr_lo; /* post write addr lo 0x38 */ 239 fwohcireg_t post_wr_hi; /* post write addr hi 0x3c */ 240 fwohcireg_t vendor; /* vendor ID 0x40 */ 241 fwohcireg_t dummy1[3]; /* dummy 0x44-0x4c */ 242 fwohcireg_t hcc_cntl_set; /* HCC control set 0x50 */ 243 fwohcireg_t hcc_cntl_clr; /* HCC control clr 0x54 */ 244#define OHCI_HCC_BIBIV (1U << 31) /* BIBimage Valid */ 245#define OHCI_HCC_BIGEND (1 << 30) /* noByteSwapData */ 246#define OHCI_HCC_PRPHY (1 << 23) /* programPhyEnable */ 247#define OHCI_HCC_PHYEN (1 << 22) /* aPhyEnhanceEnable */ 248#define OHCI_HCC_LPS (1 << 19) /* LPS */ 249#define OHCI_HCC_POSTWR (1 << 18) /* postedWriteEnable */ 250#define OHCI_HCC_LINKEN (1 << 17) /* linkEnable */ 251#define OHCI_HCC_RESET (1 << 16) /* softReset */ 252 fwohcireg_t dummy2[2]; /* dummy 0x58-0x5c */ 253 fwohcireg_t dummy3[1]; /* dummy 0x60 */ 254 fwohcireg_t sid_buf; /* self id buffer 0x64 */ 255 fwohcireg_t sid_cnt; /* self id count 0x68 */ 256 fwohcireg_t dummy4[1]; /* dummy 0x6c */ 257 fwohcireg_t ir_mask_hi_set; /* ir mask hi set 0x70 */ 258 fwohcireg_t ir_mask_hi_clr; /* ir mask hi set 0x74 */ 259 fwohcireg_t ir_mask_lo_set; /* ir mask hi set 0x78 */ 260 fwohcireg_t ir_mask_lo_clr; /* ir mask hi set 0x7c */ 261#define FWOHCI_INTSTAT 0x80 262#define FWOHCI_INTSTATCLR 0x84 263#define FWOHCI_INTMASK 0x88 264#define FWOHCI_INTMASKCLR 0x8c 265 fwohcireg_t int_stat; /* 0x80 */ 266 fwohcireg_t int_clear; /* 0x84 */ 267 fwohcireg_t int_mask; /* 0x88 */ 268 fwohcireg_t int_mask_clear; /* 0x8c */ 269 fwohcireg_t it_int_stat; /* 0x90 */ 270 fwohcireg_t it_int_clear; /* 0x94 */ 271 fwohcireg_t it_int_mask; /* 0x98 */ 272 fwohcireg_t it_mask_clear; /* 0x9c */ 273 fwohcireg_t ir_int_stat; /* 0xa0 */ 274 fwohcireg_t ir_int_clear; /* 0xa4 */ 275 fwohcireg_t ir_int_mask; /* 0xa8 */ 276 fwohcireg_t ir_mask_clear; /* 0xac */ 277 fwohcireg_t dummy5[11]; /* dummy 0xb0-d8 */ 278 fwohcireg_t fairness; /* fairness control 0xdc */ 279 fwohcireg_t link_cntl; /* Chip control 0xe0*/ 280 fwohcireg_t link_cntl_clr; /* Chip control clear 0xe4*/ 281#define FWOHCI_NODEID 0xe8 282 fwohcireg_t node; /* Node ID 0xe8 */ 283#define OHCI_NODE_VALID (1U << 31) 284#define OHCI_NODE_ROOT (1 << 30) 285 286#define OHCI_ASYSRCBUS 1 287 288 fwohcireg_t phy_access; /* PHY cntl 0xec */ 289#define PHYDEV_RDDONE (1<<31) 290#define PHYDEV_RDCMD (1<<15) 291#define PHYDEV_WRCMD (1<<14) 292#define PHYDEV_REGADDR 8 293#define PHYDEV_WRDATA 0 294#define PHYDEV_RDADDR 24 295#define PHYDEV_RDDATA 16 296 297 fwohcireg_t cycle_timer; /* Cycle Timer 0xf0 */ 298 fwohcireg_t dummy6[3]; /* dummy 0xf4-fc */ 299 fwohcireg_t areq_hi; /* Async req. filter hi 0x100 */ 300 fwohcireg_t areq_hi_clr; /* Async req. filter hi 0x104 */ 301 fwohcireg_t areq_lo; /* Async req. filter lo 0x108 */ 302 fwohcireg_t areq_lo_clr; /* Async req. filter lo 0x10c */ 303 fwohcireg_t preq_hi; /* Async req. filter hi 0x110 */ 304 fwohcireg_t preq_hi_clr; /* Async req. filter hi 0x114 */ 305 fwohcireg_t preq_lo; /* Async req. filter lo 0x118 */ 306 fwohcireg_t preq_lo_clr; /* Async req. filter lo 0x11c */ 307 308 fwohcireg_t pys_upper; /* Physical Upper bound 0x120 */ 309 310 fwohcireg_t dummy7[23]; /* dummy 0x124-0x17c */ 311 312 /* 0x180, 0x184, 0x188, 0x18c */ 313 /* 0x190, 0x194, 0x198, 0x19c */ 314 /* 0x1a0, 0x1a4, 0x1a8, 0x1ac */ 315 /* 0x1b0, 0x1b4, 0x1b8, 0x1bc */ 316 /* 0x1c0, 0x1c4, 0x1c8, 0x1cc */ 317 /* 0x1d0, 0x1d4, 0x1d8, 0x1dc */ 318 /* 0x1e0, 0x1e4, 0x1e8, 0x1ec */ 319 /* 0x1f0, 0x1f4, 0x1f8, 0x1fc */ 320 struct ohci_dma dma_ch[0x4]; 321 322 /* 0x200, 0x204, 0x208, 0x20c */ 323 /* 0x210, 0x204, 0x208, 0x20c */ 324 struct ohci_itdma dma_itch[0x20]; 325 326 /* 0x400, 0x404, 0x408, 0x40c */ 327 /* 0x410, 0x404, 0x408, 0x40c */ 328 struct ohci_dma dma_irch[0x20]; 329}; 330 331#ifndef _STANDALONE 332struct fwohcidb_tr { 333 STAILQ_ENTRY(fwohcidb_tr) link; 334 struct fw_xfer *xfer; 335 struct fwohcidb *db; 336 bus_dmamap_t dma_map; 337 caddr_t buf; 338 bus_addr_t bus_addr; 339 int dbcnt; 340}; 341#endif 342 343/* 344 * OHCI info structure. 345 */ 346struct fwohci_txpkthdr { 347 union { 348 uint32_t ld[4]; 349 struct { 350#if BYTE_ORDER == BIG_ENDIAN 351 uint32_t spd:16, /* XXX include reserved field */ 352 :8, 353 tcode:4, 354 :4; 355#else 356 uint32_t :4, 357 tcode:4, 358 :8, 359 spd:16; /* XXX include reserved fields */ 360#endif 361 }common; 362 struct { 363#if BYTE_ORDER == BIG_ENDIAN 364 uint32_t :8, 365 srcbus:1, 366 :4, 367 spd:3, 368 tlrt:8, 369 tcode:4, 370 :4; 371#else 372 uint32_t :4, 373 tcode:4, 374 tlrt:8, 375 spd:3, 376 :4, 377 srcbus:1, 378 :8; 379#endif 380 BIT16x2(dst, ); 381 } asycomm; 382 struct { 383#if BYTE_ORDER == BIG_ENDIAN 384 uint32_t :13, 385 spd:3, 386 chtag:8, 387 tcode:4, 388 sy:4; 389#else 390 uint32_t sy:4, 391 tcode:4, 392 chtag:8, 393 spd:3, 394 :13; 395#endif 396 BIT16x2(len, ); 397 } stream; 398 } mode; 399}; 400 401struct fwohci_trailer { 402#if BYTE_ORDER == BIG_ENDIAN 403 uint32_t stat:16, 404 time:16; 405#else 406 uint32_t time:16, 407 stat:16; 408#endif 409}; 410 411#define OHCI_CNTL_CYCSRC (0x1 << 22) 412#define OHCI_CNTL_CYCMTR (0x1 << 21) 413#define OHCI_CNTL_CYCTIMER (0x1 << 20) 414#define OHCI_CNTL_PHYPKT (0x1 << 10) 415#define OHCI_CNTL_SID (0x1 << 9) 416 417/* 418 * defined in OHCI 1.1 419 * chapter 6.1 420 */ 421#define OHCI_INT_DMA_ATRQ (0x1 << 0) 422#define OHCI_INT_DMA_ATRS (0x1 << 1) 423#define OHCI_INT_DMA_ARRQ (0x1 << 2) 424#define OHCI_INT_DMA_ARRS (0x1 << 3) 425#define OHCI_INT_DMA_PRRQ (0x1 << 4) 426#define OHCI_INT_DMA_PRRS (0x1 << 5) 427#define OHCI_INT_DMA_IT (0x1 << 6) 428#define OHCI_INT_DMA_IR (0x1 << 7) 429#define OHCI_INT_PW_ERR (0x1 << 8) 430#define OHCI_INT_LR_ERR (0x1 << 9) 431#define OHCI_INT_PHY_SID (0x1 << 16) 432#define OHCI_INT_PHY_BUS_R (0x1 << 17) 433#define OHCI_INT_REG_FAIL (0x1 << 18) 434#define OHCI_INT_PHY_INT (0x1 << 19) 435#define OHCI_INT_CYC_START (0x1 << 20) 436#define OHCI_INT_CYC_64SECOND (0x1 << 21) 437#define OHCI_INT_CYC_LOST (0x1 << 22) 438#define OHCI_INT_CYC_ERR (0x1 << 23) 439#define OHCI_INT_ERR (0x1 << 24) 440#define OHCI_INT_CYC_LONG (0x1 << 25) 441#define OHCI_INT_PHY_REG (0x1 << 26) 442#define OHCI_INT_EN (0x1 << 31) 443 444#define IP_CHANNELS 0x0234 445#define FWOHCI_MAXREC 2048 446 447#define OHCI_ISORA 0x02 448#define OHCI_ISORB 0x04 449 450#define FWOHCITCODE_PHY 0xe 451