drivers/scsi/aic94xx/aic94xx_hwi.h

   1 /*
   2  * Aic94xx SAS/SATA driver hardware interface header file.
   3  *
   4  * Copyright (C) 2005 Adaptec, Inc.  All rights reserved.
   5  * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
   6  *
   7  * This file is licensed under GPLv2.
   8  *
   9  * This file is part of the aic94xx driver.
  10  *
  11  * The aic94xx driver is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License as
  13  * published by the Free Software Foundation; version 2 of the
  14  * License.
  15  *
  16  * The aic94xx driver is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with the aic94xx driver; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  24  *
  25  */
  26
  27 #ifndef _AIC94XX_HWI_H_
  28 #define _AIC94XX_HWI_H_
  29
  30 #include <linux/interrupt.h>
  31 #include <linux/pci.h>
  32 #include <linux/dma-mapping.h>
  33
  34 #include <scsi/libsas.h>
  35
  36 #include "aic94xx.h"
  37 #include "aic94xx_sas.h"
  38
  39 /* Define ASD_MAX_PHYS to the maximum phys ever. Currently 8. */
  40 #define ASD_MAX_PHYS       8
  41 #define ASD_PCBA_SN_SIZE   12
  42
  43 struct asd_ha_addrspace {
  44         void __iomem  *addr;
  45         unsigned long  start;       /* pci resource start */
  46         unsigned long  len;         /* pci resource len */
  47         unsigned long  flags;       /* pci resource flags */
  48
  49         /* addresses internal to the host adapter */
  50         u32 swa_base; /* mmspace 1 (MBAR1) uses this only */
  51         u32 swb_base;
  52         u32 swc_base;
  53 };
  54
  55 struct bios_struct {
  56         int    present;
  57         u8     maj;
  58         u8     min;
  59         u32    bld;
  60 };
  61
  62 struct unit_element_struct {
  63         u16    num;
  64         u16    size;
  65         void   *area;
  66 };
  67
  68 struct flash_struct {
  69         u32    bar;
  70         int    present;
  71         int    wide;
  72         u8     manuf;
  73         u8     dev_id;
  74         u8     sec_prot;
  75         u8     method;
  76
  77         u32    dir_offs;
  78 };
  79
  80 struct asd_phy_desc {
  81         /* From CTRL-A settings, then set to what is appropriate */
  82         u8     sas_addr[SAS_ADDR_SIZE];
  83         u8     max_sas_lrate;
  84         u8     min_sas_lrate;
  85         u8     max_sata_lrate;
  86         u8     min_sata_lrate;
  87         u8     flags;
  88 #define ASD_CRC_DIS  1
  89 #define ASD_SATA_SPINUP_HOLD 2
  90
  91         u8     phy_control_0; /* mode 5 reg 0x160 */
  92         u8     phy_control_1; /* mode 5 reg 0x161 */
  93         u8     phy_control_2; /* mode 5 reg 0x162 */
  94         u8     phy_control_3; /* mode 5 reg 0x163 */
  95 };
  96
  97 struct asd_dma_tok {
  98         void *vaddr;
  99         dma_addr_t dma_handle;
 100         size_t size;
 101 };
 102
 103 struct hw_profile {
 104         struct bios_struct bios;
 105         struct unit_element_struct ue;
 106         struct flash_struct flash;
 107
 108         u8     sas_addr[SAS_ADDR_SIZE];
 109         char   pcba_sn[ASD_PCBA_SN_SIZE+1];
 110
 111         u8     enabled_phys;      /* mask of enabled phys */
 112         struct asd_phy_desc phy_desc[ASD_MAX_PHYS];
 113         u32    max_scbs;          /* absolute sequencer scb queue size */
 114         struct asd_dma_tok *scb_ext;
 115         u32    max_ddbs;
 116         struct asd_dma_tok *ddb_ext;
 117
 118         spinlock_t ddb_lock;
 119         void  *ddb_bitmap;
 120
 121         int    num_phys;          /* ENABLEABLE */
 122         int    max_phys;          /* REPORTED + ENABLEABLE */
 123
 124         unsigned addr_range;      /* max # of addrs; max # of possible ports */
 125         unsigned port_name_base;
 126         unsigned dev_name_base;
 127         unsigned sata_name_base;
 128 };
 129
 130 struct asd_ascb {
 131         struct list_head list;
 132         struct asd_ha_struct *ha;
 133
 134         struct scb *scb;          /* equals dma_scb->vaddr */
 135         struct asd_dma_tok dma_scb;
 136         struct asd_dma_tok *sg_arr;
 137
 138         void (*tasklet_complete)(struct asd_ascb *, struct done_list_struct *);
 139         u8     uldd_timer:1;
 140
 141         /* internally generated command */
 142         struct timer_list timer;
 143 <<<<<<< HEAD:drivers/scsi/aic94xx/aic94xx_hwi.h
 144         struct completion completion;
 145 =======
 146         struct completion *completion;
 147 >>>>>>> 264e3e889d86e552b4191d69bb60f4f3b383135a:drivers/scsi/aic94xx/aic94xx_hwi.h
 148         u8        tag_valid:1;
 149         __be16    tag;            /* error recovery only */
 150
 151         /* If this is an Empty SCB, index of first edb in seq->edb_arr. */
 152         int    edb_index;
 153
 154         /* Used by the timer timeout function. */
 155         int    tc_index;
 156
 157         void   *uldd_task;
 158 };
 159
 160 #define ASD_DL_SIZE_BITS   0x8
 161 #define ASD_DL_SIZE        (1<<(2+ASD_DL_SIZE_BITS))
 162 #define ASD_DEF_DL_TOGGLE  0x01
 163
 164 struct asd_seq_data {
 165         spinlock_t pend_q_lock;
 166         u16    scbpro;
 167         int    pending;
 168         struct list_head pend_q;
 169         int    can_queue;         /* per adapter */
 170         struct asd_dma_tok next_scb; /* next scb to be delivered to CSEQ */
 171
 172         spinlock_t tc_index_lock;
 173         void **tc_index_array;
 174         void *tc_index_bitmap;
 175         int   tc_index_bitmap_bits;
 176
 177         struct tasklet_struct dl_tasklet;
 178         struct done_list_struct *dl; /* array of done list entries, equals */
 179         struct asd_dma_tok *actual_dl; /* actual_dl->vaddr */
 180         int    dl_toggle;
 181         int    dl_next;
 182
 183         int    num_edbs;
 184         struct asd_dma_tok **edb_arr;
 185         int    num_escbs;
 186         struct asd_ascb **escb_arr; /* array of pointers to escbs */
 187 };
 188
 189 /* This is an internal port structure. These are used to get accurate
 190  * phy_mask for updating DDB 0.
 191  */
 192 struct asd_port {
 193         u8  sas_addr[SAS_ADDR_SIZE];
 194         u8  attached_sas_addr[SAS_ADDR_SIZE];
 195         u32 phy_mask;
 196         int num_phys;
 197 };
 198
 199 /* This is the Host Adapter structure.  It describes the hardware
 200  * SAS adapter.
 201  */
 202 struct asd_ha_struct {
 203         struct pci_dev   *pcidev;
 204         const char       *name;
 205
 206         struct sas_ha_struct sas_ha;
 207
 208         u8                revision_id;
 209
 210         int               iospace;
 211         spinlock_t        iolock;
 212         struct asd_ha_addrspace io_handle[2];
 213
 214         struct hw_profile hw_prof;
 215
 216         struct asd_phy    phys[ASD_MAX_PHYS];
 217         spinlock_t        asd_ports_lock;
 218         struct asd_port   asd_ports[ASD_MAX_PHYS];
 219         struct asd_sas_port   ports[ASD_MAX_PHYS];
 220
 221         struct dma_pool  *scb_pool;
 222
 223         struct asd_seq_data  seq; /* sequencer related */
 224         u32    bios_status;
 225         const struct firmware *bios_image;
 226 };
 227
 228 /* ---------- Common macros ---------- */
 229
 230 #define ASD_BUSADDR_LO(__dma_handle) ((u32)(__dma_handle))
 231 #define ASD_BUSADDR_HI(__dma_handle) (((sizeof(dma_addr_t))==8)     \
 232                                     ? ((u32)((__dma_handle) >> 32)) \
 233                                     : ((u32)0))
 234
 235 #define dev_to_asd_ha(__dev)  pci_get_drvdata(to_pci_dev(__dev))
 236 #define SCB_SITE_VALID(__site_no) (((__site_no) & 0xF0FF) != 0x00FF   \
 237                                  && ((__site_no) & 0xF0FF) > 0x001F)
 238 /* For each bit set in __lseq_mask, set __lseq to equal the bit
 239  * position of the set bit and execute the statement following.
 240  * __mc is the temporary mask, used as a mask "counter".
 241  */
 242 #define for_each_sequencer(__lseq_mask, __mc, __lseq)                        \
 243         for ((__mc)=(__lseq_mask),(__lseq)=0;(__mc)!=0;(__lseq++),(__mc)>>=1)\
 244                 if (((__mc) & 1))
 245 #define for_each_phy(__lseq_mask, __mc, __lseq)                              \
 246         for ((__mc)=(__lseq_mask),(__lseq)=0;(__mc)!=0;(__lseq++),(__mc)>>=1)\
 247                 if (((__mc) & 1))
 248
 249 #define PHY_ENABLED(_HA, _I) ((_HA)->hw_prof.enabled_phys & (1<<(_I)))
 250
 251 /* ---------- DMA allocs ---------- */
 252
 253 static inline struct asd_dma_tok *asd_dmatok_alloc(gfp_t flags)
 254 {
 255         return kmem_cache_alloc(asd_dma_token_cache, flags);
 256 }
 257
 258 static inline void asd_dmatok_free(struct asd_dma_tok *token)
 259 {
 260         kmem_cache_free(asd_dma_token_cache, token);
 261 }
 262
 263 static inline struct asd_dma_tok *asd_alloc_coherent(struct asd_ha_struct *
 264                                                      asd_ha, size_t size,
 265                                                      gfp_t flags)
 266 {
 267         struct asd_dma_tok *token = asd_dmatok_alloc(flags);
 268         if (token) {
 269                 token->size = size;
 270                 token->vaddr = dma_alloc_coherent(&asd_ha->pcidev->dev,
 271                                                   token->size,
 272                                                   &token->dma_handle,
 273                                                   flags);
 274                 if (!token->vaddr) {
 275                         asd_dmatok_free(token);
 276                         token = NULL;
 277                 }
 278         }
 279         return token;
 280 }
 281
 282 static inline void asd_free_coherent(struct asd_ha_struct *asd_ha,
 283                                      struct asd_dma_tok *token)
 284 {
 285         if (token) {
 286                 dma_free_coherent(&asd_ha->pcidev->dev, token->size,
 287                                   token->vaddr, token->dma_handle);
 288                 asd_dmatok_free(token);
 289         }
 290 }
 291
 292 static inline void asd_init_ascb(struct asd_ha_struct *asd_ha,
 293                                  struct asd_ascb *ascb)
 294 {
 295         INIT_LIST_HEAD(&ascb->list);
 296         ascb->scb = ascb->dma_scb.vaddr;
 297         ascb->ha = asd_ha;
 298         ascb->timer.function = NULL;
 299         init_timer(&ascb->timer);
 300         ascb->tc_index = -1;
 301 <<<<<<< HEAD:drivers/scsi/aic94xx/aic94xx_hwi.h
 302         init_completion(&ascb->completion);
 303 =======
 304 >>>>>>> 264e3e889d86e552b4191d69bb60f4f3b383135a:drivers/scsi/aic94xx/aic94xx_hwi.h
 305 }
 306
 307 /* Must be called with the tc_index_lock held!
 308  */
 309 static inline void asd_tc_index_release(struct asd_seq_data *seq, int index)
 310 {
 311         seq->tc_index_array[index] = NULL;
 312         clear_bit(index, seq->tc_index_bitmap);
 313 }
 314
 315 /* Must be called with the tc_index_lock held!
 316  */
 317 static inline int asd_tc_index_get(struct asd_seq_data *seq, void *ptr)
 318 {
 319         int index;
 320
 321         index = find_first_zero_bit(seq->tc_index_bitmap,
 322                                     seq->tc_index_bitmap_bits);
 323         if (index == seq->tc_index_bitmap_bits)
 324                 return -1;
 325
 326         seq->tc_index_array[index] = ptr;
 327         set_bit(index, seq->tc_index_bitmap);
 328
 329         return index;
 330 }
 331
 332 /* Must be called with the tc_index_lock held!
 333  */
 334 static inline void *asd_tc_index_find(struct asd_seq_data *seq, int index)
 335 {
 336         return seq->tc_index_array[index];
 337 }
 338
 339 /**
 340  * asd_ascb_free -- free a single aSCB after is has completed
 341  * @ascb: pointer to the aSCB of interest
 342  *
 343  * This frees an aSCB after it has been executed/completed by
 344  * the sequencer.
 345  */
 346 static inline void asd_ascb_free(struct asd_ascb *ascb)
 347 {
 348         if (ascb) {
 349                 struct asd_ha_struct *asd_ha = ascb->ha;
 350                 unsigned long flags;
 351
 352                 BUG_ON(!list_empty(&ascb->list));
 353                 spin_lock_irqsave(&ascb->ha->seq.tc_index_lock, flags);
 354                 asd_tc_index_release(&ascb->ha->seq, ascb->tc_index);
 355                 spin_unlock_irqrestore(&ascb->ha->seq.tc_index_lock, flags);
 356                 dma_pool_free(asd_ha->scb_pool, ascb->dma_scb.vaddr,
 357                               ascb->dma_scb.dma_handle);
 358                 kmem_cache_free(asd_ascb_cache, ascb);
 359         }
 360 }
 361
 362 /**
 363  * asd_ascb_list_free -- free a list of ascbs
 364  * @ascb_list: a list of ascbs
 365  *
 366  * This function will free a list of ascbs allocated by asd_ascb_alloc_list.
 367  * It is used when say the scb queueing function returned QUEUE_FULL,
 368  * and we do not need the ascbs any more.
 369  */
 370 static inline void asd_ascb_free_list(struct asd_ascb *ascb_list)
 371 {
 372         LIST_HEAD(list);
 373         struct list_head *n, *pos;
 374
 375         __list_add(&list, ascb_list->list.prev, &ascb_list->list);
 376         list_for_each_safe(pos, n, &list) {
 377                 list_del_init(pos);
 378                 asd_ascb_free(list_entry(pos, struct asd_ascb, list));
 379         }
 380 }
 381
 382 /* ---------- Function declarations ---------- */
 383
 384 int  asd_init_hw(struct asd_ha_struct *asd_ha);
 385 irqreturn_t asd_hw_isr(int irq, void *dev_id);
 386
 387
 388 struct asd_ascb *asd_ascb_alloc_list(struct asd_ha_struct
 389                                      *asd_ha, int *num,
 390                                      gfp_t gfp_mask);
 391
 392 int  asd_post_ascb_list(struct asd_ha_struct *asd_ha, struct asd_ascb *ascb,
 393                         int num);
 394 int  asd_post_escb_list(struct asd_ha_struct *asd_ha, struct asd_ascb *ascb,
 395                         int num);
 396
 397 int  asd_init_post_escbs(struct asd_ha_struct *asd_ha);
 398 void asd_build_control_phy(struct asd_ascb *ascb, int phy_id, u8 subfunc);
 399 void asd_control_led(struct asd_ha_struct *asd_ha, int phy_id, int op);
 400 void asd_turn_led(struct asd_ha_struct *asd_ha, int phy_id, int op);
 401 int  asd_enable_phys(struct asd_ha_struct *asd_ha, const u8 phy_mask);
 402 void asd_build_initiate_link_adm_task(struct asd_ascb *ascb, int phy_id,
 403                                       u8 subfunc);
 404
 405 void asd_ascb_timedout(unsigned long data);
 406 int  asd_chip_hardrst(struct asd_ha_struct *asd_ha);
 407
 408 #endif