14782ac80SJin Zhengxiong /* 24c2e3da8SKumar Gala * Copyright (C) Freescale Semiconductor, Inc. 2006. 34782ac80SJin Zhengxiong * Author: Jason Jin<Jason.jin@freescale.com> 44782ac80SJin Zhengxiong * Zhang Wei<wei.zhang@freescale.com> 54782ac80SJin Zhengxiong * 61a459660SWolfgang Denk * SPDX-License-Identifier: GPL-2.0+ 74782ac80SJin Zhengxiong */ 84782ac80SJin Zhengxiong #ifndef _AHCI_H_ 94782ac80SJin Zhengxiong #define _AHCI_H_ 104782ac80SJin Zhengxiong 11942e3143SRob Herring #include <pci.h> 12942e3143SRob Herring 134782ac80SJin Zhengxiong #define AHCI_PCI_BAR 0x24 144782ac80SJin Zhengxiong #define AHCI_MAX_SG 56 /* hardware max is 64K */ 154782ac80SJin Zhengxiong #define AHCI_CMD_SLOT_SZ 32 169f472e65SStefano Babic #define AHCI_MAX_CMD_SLOT 32 174782ac80SJin Zhengxiong #define AHCI_RX_FIS_SZ 256 184782ac80SJin Zhengxiong #define AHCI_CMD_TBL_HDR 0x80 194782ac80SJin Zhengxiong #define AHCI_CMD_TBL_CDB 0x40 204782ac80SJin Zhengxiong #define AHCI_CMD_TBL_SZ AHCI_CMD_TBL_HDR + (AHCI_MAX_SG * 16) 219f472e65SStefano Babic #define AHCI_PORT_PRIV_DMA_SZ (AHCI_CMD_SLOT_SZ * AHCI_MAX_CMD_SLOT + \ 229f472e65SStefano Babic AHCI_CMD_TBL_SZ + AHCI_RX_FIS_SZ) 234782ac80SJin Zhengxiong #define AHCI_CMD_ATAPI (1 << 5) 244782ac80SJin Zhengxiong #define AHCI_CMD_WRITE (1 << 6) 254782ac80SJin Zhengxiong #define AHCI_CMD_PREFETCH (1 << 7) 264782ac80SJin Zhengxiong #define AHCI_CMD_RESET (1 << 8) 274782ac80SJin Zhengxiong #define AHCI_CMD_CLR_BUSY (1 << 10) 284782ac80SJin Zhengxiong 294782ac80SJin Zhengxiong #define RX_FIS_D2H_REG 0x40 /* offset of D2H Register FIS data */ 304782ac80SJin Zhengxiong 314782ac80SJin Zhengxiong /* Global controller registers */ 324782ac80SJin Zhengxiong #define HOST_CAP 0x00 /* host capabilities */ 334782ac80SJin Zhengxiong #define HOST_CTL 0x04 /* global host control */ 344782ac80SJin Zhengxiong #define HOST_IRQ_STAT 0x08 /* interrupt status */ 354782ac80SJin Zhengxiong #define HOST_PORTS_IMPL 0x0c /* bitmap of implemented ports */ 364782ac80SJin Zhengxiong #define HOST_VERSION 0x10 /* AHCI spec. version compliancy */ 374e422bceSStefan Reinauer #define HOST_CAP2 0x24 /* host capabilities, extended */ 384782ac80SJin Zhengxiong 394782ac80SJin Zhengxiong /* HOST_CTL bits */ 404782ac80SJin Zhengxiong #define HOST_RESET (1 << 0) /* reset controller; self-clear */ 414782ac80SJin Zhengxiong #define HOST_IRQ_EN (1 << 1) /* global IRQ enable */ 424782ac80SJin Zhengxiong #define HOST_AHCI_EN (1 << 31) /* AHCI enabled */ 434782ac80SJin Zhengxiong 444782ac80SJin Zhengxiong /* Registers for each SATA port */ 454782ac80SJin Zhengxiong #define PORT_LST_ADDR 0x00 /* command list DMA addr */ 464782ac80SJin Zhengxiong #define PORT_LST_ADDR_HI 0x04 /* command list DMA addr hi */ 474782ac80SJin Zhengxiong #define PORT_FIS_ADDR 0x08 /* FIS rx buf addr */ 484782ac80SJin Zhengxiong #define PORT_FIS_ADDR_HI 0x0c /* FIS rx buf addr hi */ 494782ac80SJin Zhengxiong #define PORT_IRQ_STAT 0x10 /* interrupt status */ 504782ac80SJin Zhengxiong #define PORT_IRQ_MASK 0x14 /* interrupt enable/disable mask */ 514782ac80SJin Zhengxiong #define PORT_CMD 0x18 /* port command */ 524782ac80SJin Zhengxiong #define PORT_TFDATA 0x20 /* taskfile data */ 534782ac80SJin Zhengxiong #define PORT_SIG 0x24 /* device TF signature */ 544782ac80SJin Zhengxiong #define PORT_CMD_ISSUE 0x38 /* command issue */ 554782ac80SJin Zhengxiong #define PORT_SCR 0x28 /* SATA phy register block */ 564782ac80SJin Zhengxiong #define PORT_SCR_STAT 0x28 /* SATA phy register: SStatus */ 574782ac80SJin Zhengxiong #define PORT_SCR_CTL 0x2c /* SATA phy register: SControl */ 584782ac80SJin Zhengxiong #define PORT_SCR_ERR 0x30 /* SATA phy register: SError */ 594782ac80SJin Zhengxiong #define PORT_SCR_ACT 0x34 /* SATA phy register: SActive */ 604782ac80SJin Zhengxiong 61a6e50a88SIan Campbell #ifdef CONFIG_SUNXI_AHCI 62a6e50a88SIan Campbell #define PORT_P0DMACR 0x70 /* SUNXI specific "DMA register" */ 63a6e50a88SIan Campbell #endif 64a6e50a88SIan Campbell 654782ac80SJin Zhengxiong /* PORT_IRQ_{STAT,MASK} bits */ 664782ac80SJin Zhengxiong #define PORT_IRQ_COLD_PRES (1 << 31) /* cold presence detect */ 674782ac80SJin Zhengxiong #define PORT_IRQ_TF_ERR (1 << 30) /* task file error */ 684782ac80SJin Zhengxiong #define PORT_IRQ_HBUS_ERR (1 << 29) /* host bus fatal error */ 694782ac80SJin Zhengxiong #define PORT_IRQ_HBUS_DATA_ERR (1 << 28) /* host bus data error */ 704782ac80SJin Zhengxiong #define PORT_IRQ_IF_ERR (1 << 27) /* interface fatal error */ 714782ac80SJin Zhengxiong #define PORT_IRQ_IF_NONFATAL (1 << 26) /* interface non-fatal error */ 724782ac80SJin Zhengxiong #define PORT_IRQ_OVERFLOW (1 << 24) /* xfer exhausted available S/G */ 734782ac80SJin Zhengxiong #define PORT_IRQ_BAD_PMP (1 << 23) /* incorrect port multiplier */ 744782ac80SJin Zhengxiong 754782ac80SJin Zhengxiong #define PORT_IRQ_PHYRDY (1 << 22) /* PhyRdy changed */ 764782ac80SJin Zhengxiong #define PORT_IRQ_DEV_ILCK (1 << 7) /* device interlock */ 774782ac80SJin Zhengxiong #define PORT_IRQ_CONNECT (1 << 6) /* port connect change status */ 784782ac80SJin Zhengxiong #define PORT_IRQ_SG_DONE (1 << 5) /* descriptor processed */ 794782ac80SJin Zhengxiong #define PORT_IRQ_UNK_FIS (1 << 4) /* unknown FIS rx'd */ 804782ac80SJin Zhengxiong #define PORT_IRQ_SDB_FIS (1 << 3) /* Set Device Bits FIS rx'd */ 814782ac80SJin Zhengxiong #define PORT_IRQ_DMAS_FIS (1 << 2) /* DMA Setup FIS rx'd */ 824782ac80SJin Zhengxiong #define PORT_IRQ_PIOS_FIS (1 << 1) /* PIO Setup FIS rx'd */ 834782ac80SJin Zhengxiong #define PORT_IRQ_D2H_REG_FIS (1 << 0) /* D2H Register FIS rx'd */ 844782ac80SJin Zhengxiong 854782ac80SJin Zhengxiong #define PORT_IRQ_FATAL PORT_IRQ_TF_ERR | PORT_IRQ_HBUS_ERR \ 864782ac80SJin Zhengxiong | PORT_IRQ_HBUS_DATA_ERR | PORT_IRQ_IF_ERR 874782ac80SJin Zhengxiong 884782ac80SJin Zhengxiong #define DEF_PORT_IRQ PORT_IRQ_FATAL | PORT_IRQ_PHYRDY \ 894782ac80SJin Zhengxiong | PORT_IRQ_CONNECT | PORT_IRQ_SG_DONE \ 904782ac80SJin Zhengxiong | PORT_IRQ_UNK_FIS | PORT_IRQ_SDB_FIS \ 914782ac80SJin Zhengxiong | PORT_IRQ_DMAS_FIS | PORT_IRQ_PIOS_FIS \ 924782ac80SJin Zhengxiong | PORT_IRQ_D2H_REG_FIS 934782ac80SJin Zhengxiong 942bdb10dbSRob Herring /* PORT_SCR_STAT bits */ 952bdb10dbSRob Herring #define PORT_SCR_STAT_DET_MASK 0x3 962bdb10dbSRob Herring #define PORT_SCR_STAT_DET_COMINIT 0x1 972bdb10dbSRob Herring #define PORT_SCR_STAT_DET_PHYRDY 0x3 982bdb10dbSRob Herring 994782ac80SJin Zhengxiong /* PORT_CMD bits */ 1004782ac80SJin Zhengxiong #define PORT_CMD_ATAPI (1 << 24) /* Device is ATAPI */ 1014782ac80SJin Zhengxiong #define PORT_CMD_LIST_ON (1 << 15) /* cmd list DMA engine running */ 1024782ac80SJin Zhengxiong #define PORT_CMD_FIS_ON (1 << 14) /* FIS DMA engine running */ 1034782ac80SJin Zhengxiong #define PORT_CMD_FIS_RX (1 << 4) /* Enable FIS receive DMA engine */ 1044782ac80SJin Zhengxiong #define PORT_CMD_CLO (1 << 3) /* Command list override */ 1054782ac80SJin Zhengxiong #define PORT_CMD_POWER_ON (1 << 2) /* Power up device */ 1064782ac80SJin Zhengxiong #define PORT_CMD_SPIN_UP (1 << 1) /* Spin up device */ 1074782ac80SJin Zhengxiong #define PORT_CMD_START (1 << 0) /* Enable port DMA engine */ 1084782ac80SJin Zhengxiong 1094782ac80SJin Zhengxiong #define PORT_CMD_ICC_ACTIVE (0x1 << 28) /* Put i/f in active state */ 1104782ac80SJin Zhengxiong #define PORT_CMD_ICC_PARTIAL (0x2 << 28) /* Put i/f in partial state */ 1114782ac80SJin Zhengxiong #define PORT_CMD_ICC_SLUMBER (0x6 << 28) /* Put i/f in slumber state */ 1124782ac80SJin Zhengxiong 1134782ac80SJin Zhengxiong #define AHCI_MAX_PORTS 32 1144782ac80SJin Zhengxiong 1154782ac80SJin Zhengxiong #define ATA_FLAG_SATA (1 << 3) 1164782ac80SJin Zhengxiong #define ATA_FLAG_NO_LEGACY (1 << 4) /* no legacy mode check */ 1174782ac80SJin Zhengxiong #define ATA_FLAG_MMIO (1 << 6) /* use MMIO, not PIO */ 1184782ac80SJin Zhengxiong #define ATA_FLAG_SATA_RESET (1 << 7) /* (obsolete) use COMRESET */ 1194782ac80SJin Zhengxiong #define ATA_FLAG_PIO_DMA (1 << 8) /* PIO cmds via DMA */ 1204782ac80SJin Zhengxiong #define ATA_FLAG_NO_ATAPI (1 << 11) /* No ATAPI support */ 1214782ac80SJin Zhengxiong 1224782ac80SJin Zhengxiong struct ahci_cmd_hdr { 1234782ac80SJin Zhengxiong u32 opts; 1244782ac80SJin Zhengxiong u32 status; 1254782ac80SJin Zhengxiong u32 tbl_addr; 1264782ac80SJin Zhengxiong u32 tbl_addr_hi; 1274782ac80SJin Zhengxiong u32 reserved[4]; 1284782ac80SJin Zhengxiong }; 1294782ac80SJin Zhengxiong 1304782ac80SJin Zhengxiong struct ahci_sg { 1314782ac80SJin Zhengxiong u32 addr; 1324782ac80SJin Zhengxiong u32 addr_hi; 1334782ac80SJin Zhengxiong u32 reserved; 1344782ac80SJin Zhengxiong u32 flags_size; 1354782ac80SJin Zhengxiong }; 1364782ac80SJin Zhengxiong 1374782ac80SJin Zhengxiong struct ahci_ioports { 138fa31377eSTang Yuantian void __iomem *cmd_addr; 139fa31377eSTang Yuantian void __iomem *scr_addr; 140fa31377eSTang Yuantian void __iomem *port_mmio; 1414782ac80SJin Zhengxiong struct ahci_cmd_hdr *cmd_slot; 1424782ac80SJin Zhengxiong struct ahci_sg *cmd_tbl_sg; 143fa31377eSTang Yuantian ulong cmd_tbl; 1444782ac80SJin Zhengxiong u32 rx_fis; 1454782ac80SJin Zhengxiong }; 1464782ac80SJin Zhengxiong 1472c9f9efbSSimon Glass /** 1482c9f9efbSSimon Glass * struct ahci_uc_priv - information about an AHCI controller 1492c9f9efbSSimon Glass * 1502c9f9efbSSimon Glass * When driver model is used, this is accessible using dev_get_uclass_priv(dev) 1512c9f9efbSSimon Glass * where dev is the controller (although at present it sometimes stands alone). 1522c9f9efbSSimon Glass */ 1532c9f9efbSSimon Glass struct ahci_uc_priv { 154e8a016b5SMichal Simek #if defined(CONFIG_DM_PCI) || defined(CONFIG_DM_SCSI) 1552c9f9efbSSimon Glass /* 1562c9f9efbSSimon Glass * TODO(sjg@chromium.org): Drop this once this structure is only used 1572c9f9efbSSimon Glass * in a driver-model context (i.e. attached to a device with 1582c9f9efbSSimon Glass * dev_get_uclass_priv() 1592c9f9efbSSimon Glass */ 160ff758cccSSimon Glass struct udevice *dev; 161ff758cccSSimon Glass #else 1624782ac80SJin Zhengxiong pci_dev_t dev; 163ff758cccSSimon Glass #endif 1644782ac80SJin Zhengxiong struct ahci_ioports port[AHCI_MAX_PORTS]; 1654b62b2ffSSimon Glass u16 *ataid[AHCI_MAX_PORTS]; 1664782ac80SJin Zhengxiong u32 n_ports; 1674782ac80SJin Zhengxiong u32 hard_port_no; 1684782ac80SJin Zhengxiong u32 host_flags; 1694782ac80SJin Zhengxiong u32 host_set_flags; 1709efaca3eSScott Wood void __iomem *mmio_base; 1714782ac80SJin Zhengxiong u32 pio_mask; 1724782ac80SJin Zhengxiong u32 udma_mask; 1734782ac80SJin Zhengxiong u32 flags; 1744782ac80SJin Zhengxiong u32 cap; /* cache of HOST_CAP register */ 1754782ac80SJin Zhengxiong u32 port_map; /* cache of HOST_PORTS_IMPL reg */ 1764782ac80SJin Zhengxiong u32 link_port_map; /*linkup port map*/ 1774782ac80SJin Zhengxiong }; 1784782ac80SJin Zhengxiong 179*b8341f1cSSimon Glass struct ahci_ops { 180*b8341f1cSSimon Glass /** 181*b8341f1cSSimon Glass * reset() - reset the controller 182*b8341f1cSSimon Glass * 183*b8341f1cSSimon Glass * @dev: Controller to reset 184*b8341f1cSSimon Glass * @return 0 if OK, -ve on error 185*b8341f1cSSimon Glass */ 186*b8341f1cSSimon Glass int (*reset)(struct udevice *dev); 187*b8341f1cSSimon Glass 188*b8341f1cSSimon Glass /** 189*b8341f1cSSimon Glass * port_status() - get the status of a SATA port 190*b8341f1cSSimon Glass * 191*b8341f1cSSimon Glass * @dev: Controller to reset 192*b8341f1cSSimon Glass * @port: Port number to check (0 for first) 193*b8341f1cSSimon Glass * @return 0 if detected, -ENXIO if nothing on port, other -ve on error 194*b8341f1cSSimon Glass */ 195*b8341f1cSSimon Glass int (*port_status)(struct udevice *dev, int port); 196*b8341f1cSSimon Glass 197*b8341f1cSSimon Glass /** 198*b8341f1cSSimon Glass * scan() - scan SATA ports 199*b8341f1cSSimon Glass * 200*b8341f1cSSimon Glass * @dev: Controller to scan 201*b8341f1cSSimon Glass * @return 0 if OK, -ve on error 202*b8341f1cSSimon Glass */ 203*b8341f1cSSimon Glass int (*scan)(struct udevice *dev); 204*b8341f1cSSimon Glass }; 205*b8341f1cSSimon Glass 206*b8341f1cSSimon Glass #define ahci_get_ops(dev) ((struct ahci_ops *)(dev)->driver->ops) 207*b8341f1cSSimon Glass 208*b8341f1cSSimon Glass /** 209*b8341f1cSSimon Glass * sata_reset() - reset the controller 210*b8341f1cSSimon Glass * 211*b8341f1cSSimon Glass * @dev: Controller to reset 212*b8341f1cSSimon Glass * @return 0 if OK, -ve on error 213*b8341f1cSSimon Glass */ 214*b8341f1cSSimon Glass int sata_reset(struct udevice *dev); 215*b8341f1cSSimon Glass 216*b8341f1cSSimon Glass /** 217*b8341f1cSSimon Glass * sata_port_status() - get the status of a SATA port 218*b8341f1cSSimon Glass * 219*b8341f1cSSimon Glass * @dev: Controller to reset 220*b8341f1cSSimon Glass * @port: Port number to check (0 for first) 221*b8341f1cSSimon Glass * @return 0 if detected, -ENXIO if nothin on port, other -ve on error 222*b8341f1cSSimon Glass */ 223*b8341f1cSSimon Glass int sata_dm_port_status(struct udevice *dev, int port); 224*b8341f1cSSimon Glass 225*b8341f1cSSimon Glass /** 226*b8341f1cSSimon Glass * sata_scan() - scan SATA ports 227*b8341f1cSSimon Glass * 228*b8341f1cSSimon Glass * @dev: Controller to scan 229*b8341f1cSSimon Glass * @return 0 if OK, -ve on error 230*b8341f1cSSimon Glass */ 231*b8341f1cSSimon Glass int sata_scan(struct udevice *dev); 232*b8341f1cSSimon Glass 2339efaca3eSScott Wood int ahci_init(void __iomem *base); 2349efaca3eSScott Wood int ahci_reset(void __iomem *base); 235942e3143SRob Herring 2367cf1afceSSimon Glass /** 2377cf1afceSSimon Glass * achi_init_one_dm() - set up a single AHCI port 2387cf1afceSSimon Glass * 2397cf1afceSSimon Glass * @dev: Controller to init 2407cf1afceSSimon Glass */ 2417cf1afceSSimon Glass int achi_init_one_dm(struct udevice *dev); 2427cf1afceSSimon Glass 2437cf1afceSSimon Glass /** 2447cf1afceSSimon Glass * achi_start_ports_dm() - start all AHCI ports for a controller 2457cf1afceSSimon Glass * 2467cf1afceSSimon Glass * @dev: Controller containing ports to start 2477cf1afceSSimon Glass */ 2487cf1afceSSimon Glass int achi_start_ports_dm(struct udevice *dev); 2497cf1afceSSimon Glass 2504279efc4SSimon Glass /** 2514279efc4SSimon Glass * ahci_init_dm() - init AHCI for a controller, finding all ports 2524279efc4SSimon Glass * 2534279efc4SSimon Glass * @dev: Device to init 2544279efc4SSimon Glass */ 2554279efc4SSimon Glass int ahci_init_dm(struct udevice *dev, void __iomem *base); 2564279efc4SSimon Glass 257681357ffSSimon Glass /** 258681357ffSSimon Glass * ahci_bind_scsi() - bind a new SCSI bus as a child 259681357ffSSimon Glass * 260681357ffSSimon Glass * Note that the SCSI bus device will itself bind block devices 261681357ffSSimon Glass * 262681357ffSSimon Glass * @ahci_dev: AHCI parent device 263681357ffSSimon Glass * @devp: Returns new SCSI bus device 264681357ffSSimon Glass * @return 0 if OK, -ve on error 265681357ffSSimon Glass */ 266681357ffSSimon Glass int ahci_bind_scsi(struct udevice *ahci_dev, struct udevice **devp); 267681357ffSSimon Glass 268681357ffSSimon Glass /** 269681357ffSSimon Glass * ahci_probe_scsi() - probe and scan the attached SCSI bus 270681357ffSSimon Glass * 271681357ffSSimon Glass * Note that the SCSI device will itself bind block devices for any storage 272681357ffSSimon Glass * devices it finds. 273681357ffSSimon Glass * 274681357ffSSimon Glass * @ahci_dev: AHCI parent device 275745a94f3SSimon Glass * @base: Base address of AHCI port 276681357ffSSimon Glass * @return 0 if OK, -ve on error 277681357ffSSimon Glass */ 278745a94f3SSimon Glass int ahci_probe_scsi(struct udevice *ahci_dev, ulong base); 279745a94f3SSimon Glass 280745a94f3SSimon Glass /** 281745a94f3SSimon Glass * ahci_probe_scsi_pci() - probe and scan the attached SCSI bus on PCI 282745a94f3SSimon Glass * 283745a94f3SSimon Glass * Note that the SCSI device will itself bind block devices for any storage 284745a94f3SSimon Glass * devices it finds. 285745a94f3SSimon Glass * 286745a94f3SSimon Glass * @ahci_dev: AHCI parent device 287745a94f3SSimon Glass * @return 0 if OK, -ve on error 288745a94f3SSimon Glass */ 289745a94f3SSimon Glass int ahci_probe_scsi_pci(struct udevice *ahci_dev); 290681357ffSSimon Glass 2914782ac80SJin Zhengxiong #endif 292