lunaix-os/includes/hal/ahci/hba.h

   1 #ifndef __LUNAIX_HBA_H
   2 #define __LUNAIX_HBA_H
   3
   4 #include <lunaix/blkio.h>
   5 #include <lunaix/buffer.h>
   6 #include <lunaix/types.h>
   7
   8 #define HBA_RCAP 0
   9 #define HBA_RGHC 1
  10 #define HBA_RIS 2
  11 #define HBA_RPI 3
  12 #define HBA_RVER 4
  13
  14 #define HBA_RPBASE (0x40)
  15 #define HBA_RPSIZE (0x80 >> 2)
  16 #define HBA_RPxCLB 0
  17 #define HBA_RPxFB 2
  18 #define HBA_RPxIS 4
  19 #define HBA_RPxIE 5
  20 #define HBA_RPxCMD 6
  21 #define HBA_RPxTFD 8
  22 #define HBA_RPxSIG 9
  23 #define HBA_RPxSSTS 10
  24 #define HBA_RPxSCTL 11
  25 #define HBA_RPxSERR 12
  26 #define HBA_RPxSACT 13
  27 #define HBA_RPxCI 14
  28 #define HBA_RPxSNTF 15
  29 #define HBA_RPxFBS 16
  30
  31 #define HBA_PxCMD_FRE (1 << 4)
  32 #define HBA_PxCMD_CR (1 << 15)
  33 #define HBA_PxCMD_FR (1 << 14)
  34 #define HBA_PxCMD_ST (1)
  35 #define HBA_PxINTR_DMA (1 << 2)
  36 #define HBA_PxINTR_DHR (1)
  37 #define HBA_PxINTR_DPS (1 << 5)
  38 #define HBA_PxINTR_TFEE (1 << 30)
  39 #define HBA_PxINTR_IFE (1 << 27)
  40 #define HBA_PxTFD_ERR (1)
  41 #define HBA_PxTFD_BSY (1 << 7)
  42 #define HBA_PxTFD_DRQ (1 << 3)
  43
  44 #define HBA_RGHC_ACHI_ENABLE (1 << 31)
  45 #define HBA_RGHC_INTR_ENABLE (1 << 1)
  46 #define HBA_RGHC_RESET 1
  47
  48 #define HBA_RPxSSTS_PWR(x) (((x) >> 8) & 0xf)
  49 #define HBA_RPxSSTS_IF(x) (((x) >> 4) & 0xf)
  50 #define HBA_RPxSSTS_PHYSTATE(x) ((x)&0xf)
  51
  52 #define hba_clear_reg(reg) (reg) = -1
  53
  54 #define HBA_DEV_SIG_ATAPI 0xeb140101
  55 #define HBA_DEV_SIG_ATA 0x00000101
  56
  57 #define __HBA_PACKED__ __attribute__((packed))
  58
  59 typedef unsigned int hba_reg_t;
  60
  61 #define HBA_CMDH_FIS_LEN(fis_bytes) (((fis_bytes) / 4) & 0x1f)
  62 #define HBA_CMDH_ATAPI (1 << 5)
  63 #define HBA_CMDH_WRITE (1 << 6)
  64 #define HBA_CMDH_PREFETCH (1 << 7)
  65 #define HBA_CMDH_R (1 << 8)
  66 #define HBA_CMDH_CLR_BUSY (1 << 10)
  67 #define HBA_CMDH_PRDT_LEN(entries) (((entries)&0xffff) << 16)
  68
  69 #define HBA_MAX_PRDTE 4
  70
  71 struct hba_cmdh
  72 {
  73     uint16_t options;
  74     uint16_t prdt_len;
  75     uint32_t transferred_size;
  76     uint32_t cmd_table_base;
  77     uint32_t reserved[5];
  78 } __HBA_PACKED__;
  79
  80 #define HBA_PRDTE_BYTE_CNT(cnt) ((cnt & 0x3FFFFF) | 0x1)
  81
  82 struct hba_prdte
  83 {
  84     uint32_t data_base;
  85     uint32_t reserved[2];
  86     uint32_t byte_count;
  87 } __HBA_PACKED__;
  88
  89 struct hba_cmdt
  90 {
  91     uint8_t command_fis[64];
  92     uint8_t atapi_cmd[16];
  93     uint8_t reserved[0x30];
  94     struct hba_prdte entries[HBA_MAX_PRDTE];
  95 } __HBA_PACKED__;
  96
  97 #define HBA_DEV_FEXTLBA 1
  98 #define HBA_DEV_FATAPI (1 << 1)
  99
 100 struct hba_port;
 101
 102 struct hba_device
 103 {
 104     char serial_num[20];
 105     char model[40];
 106     uint32_t flags;
 107     uint64_t max_lba;
 108     uint32_t block_size;
 109     uint64_t wwn;
 110     uint8_t cbd_size;
 111     struct
 112     {
 113         uint8_t sense_key;
 114         uint8_t error;
 115         uint8_t status;
 116         uint8_t reserve;
 117     } last_result;
 118     uint32_t alignment_offset;
 119     uint32_t block_per_sec;
 120     uint32_t capabilities;
 121     struct hba_port* port;
 122
 123     struct
 124     {
 125         int (*identify)(struct hba_device* dev);
 126         void (*submit)(struct hba_device* dev, struct blkio_req* io_req);
 127     } ops;
 128 };
 129
 130 struct hba_cmd_state
 131 {
 132     struct hba_cmdt* cmd_table;
 133     void* state_ctx;
 134 };
 135
 136 struct hba_cmd_context
 137 {
 138     struct hba_cmd_state* issued[32];
 139     u32_t tracked_ci;
 140 };
 141
 142 struct hba_port
 143 {
 144     volatile hba_reg_t* regs;
 145     unsigned int ssts;
 146     struct hba_cmdh* cmdlst;
 147     struct hba_cmd_context cmdctx;
 148     void* fis;
 149     struct hba_device* device;
 150 };
 151
 152 struct ahci_hba
 153 {
 154     volatile hba_reg_t* base;
 155     unsigned int ports_num;
 156     unsigned int ports_bmp;
 157     unsigned int cmd_slots;
 158     unsigned int version;
 159     struct hba_port* ports[32];
 160 };
 161
 162 int
 163 hba_prepare_cmd(struct hba_port* port,
 164                 struct hba_cmdt** cmdt,
 165                 struct hba_cmdh** cmdh);
 166
 167 int
 168 hba_bind_vbuf(struct hba_cmdh* cmdh,
 169               struct hba_cmdt* cmdt,
 170               struct vecbuf* vbuf);
 171
 172 int
 173 hba_bind_sbuf(struct hba_cmdh* cmdh, struct hba_cmdt* cmdt, struct membuf mbuf);
 174
 175 #endif /* __LUNAIX_HBA_H */