2 * Aic94xx SAS/SATA driver hardware interface header file.
4 * Copyright (C) 2005 Adaptec, Inc. All rights reserved.
5 * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
7 * This file is licensed under GPLv2.
9 * This file is part of the aic94xx driver.
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
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.
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
27 #ifndef _AIC94XX_HWI_H_
28 #define _AIC94XX_HWI_H_
30 #include <linux/interrupt.h>
31 #include <linux/pci.h>
32 #include <linux/dma-mapping.h>
34 #include <scsi/libsas.h>
37 #include "aic94xx_sas.h"
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
43 /* Those are to be further named properly, the "RAZORx" part, and
44 * subsequently included in include/linux/pci_ids.h.
46 #define PCI_DEVICE_ID_ADAPTEC2_RAZOR10 0x410
47 #define PCI_DEVICE_ID_ADAPTEC2_RAZOR12 0x412
48 #define PCI_DEVICE_ID_ADAPTEC2_RAZOR1E 0x41E
49 #define PCI_DEVICE_ID_ADAPTEC2_RAZOR1F 0x41F
50 #define PCI_DEVICE_ID_ADAPTEC2_RAZOR30 0x430
51 #define PCI_DEVICE_ID_ADAPTEC2_RAZOR32 0x432
52 #define PCI_DEVICE_ID_ADAPTEC2_RAZOR3E 0x43E
53 #define PCI_DEVICE_ID_ADAPTEC2_RAZOR3F 0x43F
55 struct asd_ha_addrspace {
57 unsigned long start; /* pci resource start */
58 unsigned long len; /* pci resource len */
59 unsigned long flags; /* pci resource flags */
61 /* addresses internal to the host adapter */
62 u32 swa_base; /* mmspace 1 (MBAR1) uses this only */
74 struct unit_element_struct {
92 /* From CTRL-A settings, then set to what is appropriate */
93 u8 sas_addr[SAS_ADDR_SIZE];
100 #define ASD_SATA_SPINUP_HOLD 2
102 u8 phy_control_0; /* mode 5 reg 0x160 */
103 u8 phy_control_1; /* mode 5 reg 0x161 */
104 u8 phy_control_2; /* mode 5 reg 0x162 */
105 u8 phy_control_3; /* mode 5 reg 0x163 */
110 dma_addr_t dma_handle;
115 struct bios_struct bios;
116 struct unit_element_struct ue;
117 struct flash_struct flash;
119 u8 sas_addr[SAS_ADDR_SIZE];
120 char pcba_sn[ASD_PCBA_SN_SIZE+1];
122 u8 enabled_phys; /* mask of enabled phys */
123 struct asd_phy_desc phy_desc[ASD_MAX_PHYS];
124 u32 max_scbs; /* absolute sequencer scb queue size */
125 struct asd_dma_tok *scb_ext;
127 struct asd_dma_tok *ddb_ext;
132 int num_phys; /* ENABLEABLE */
133 int max_phys; /* REPORTED + ENABLEABLE */
135 unsigned addr_range; /* max # of addrs; max # of possible ports */
136 unsigned port_name_base;
137 unsigned dev_name_base;
138 unsigned sata_name_base;
142 struct list_head list;
143 struct asd_ha_struct *ha;
145 struct scb *scb; /* equals dma_scb->vaddr */
146 struct asd_dma_tok dma_scb;
147 struct asd_dma_tok *sg_arr;
149 void (*tasklet_complete)(struct asd_ascb *, struct done_list_struct *);
152 /* internally generated command */
153 struct timer_list timer;
154 struct completion completion;
156 __be16 tag; /* error recovery only */
158 /* If this is an Empty SCB, index of first edb in seq->edb_arr. */
161 /* Used by the timer timeout function. */
167 #define ASD_DL_SIZE_BITS 0x8
168 #define ASD_DL_SIZE (1<<(2+ASD_DL_SIZE_BITS))
169 #define ASD_DEF_DL_TOGGLE 0x01
171 struct asd_seq_data {
172 spinlock_t pend_q_lock;
175 struct list_head pend_q;
176 int can_queue; /* per adapter */
177 struct asd_dma_tok next_scb; /* next scb to be delivered to CSEQ */
179 spinlock_t tc_index_lock;
180 void **tc_index_array;
181 void *tc_index_bitmap;
182 int tc_index_bitmap_bits;
184 struct tasklet_struct dl_tasklet;
185 struct done_list_struct *dl; /* array of done list entries, equals */
186 struct asd_dma_tok *actual_dl; /* actual_dl->vaddr */
191 struct asd_dma_tok **edb_arr;
193 struct asd_ascb **escb_arr; /* array of pointers to escbs */
196 /* This is the Host Adapter structure. It describes the hardware
199 struct asd_ha_struct {
200 struct pci_dev *pcidev;
203 struct sas_ha_struct sas_ha;
209 struct asd_ha_addrspace io_handle[2];
211 struct hw_profile hw_prof;
213 struct asd_phy phys[ASD_MAX_PHYS];
214 struct asd_sas_port ports[ASD_MAX_PHYS];
216 struct dma_pool *scb_pool;
218 struct asd_seq_data seq; /* sequencer related */
221 /* ---------- Common macros ---------- */
223 #define ASD_BUSADDR_LO(__dma_handle) ((u32)(__dma_handle))
224 #define ASD_BUSADDR_HI(__dma_handle) (((sizeof(dma_addr_t))==8) \
225 ? ((u32)((__dma_handle) >> 32)) \
228 #define dev_to_asd_ha(__dev) pci_get_drvdata(to_pci_dev(__dev))
229 #define SCB_SITE_VALID(__site_no) (((__site_no) & 0xF0FF) != 0x00FF \
230 && ((__site_no) & 0xF0FF) > 0x001F)
231 /* For each bit set in __lseq_mask, set __lseq to equal the bit
232 * position of the set bit and execute the statement following.
233 * __mc is the temporary mask, used as a mask "counter".
235 #define for_each_sequencer(__lseq_mask, __mc, __lseq) \
236 for ((__mc)=(__lseq_mask),(__lseq)=0;(__mc)!=0;(__lseq++),(__mc)>>=1)\
238 #define for_each_phy(__lseq_mask, __mc, __lseq) \
239 for ((__mc)=(__lseq_mask),(__lseq)=0;(__mc)!=0;(__lseq++),(__mc)>>=1)\
242 #define PHY_ENABLED(_HA, _I) ((_HA)->hw_prof.enabled_phys & (1<<(_I)))
244 /* ---------- DMA allocs ---------- */
246 static inline struct asd_dma_tok *asd_dmatok_alloc(gfp_t flags)
248 return kmem_cache_alloc(asd_dma_token_cache, flags);
251 static inline void asd_dmatok_free(struct asd_dma_tok *token)
253 kmem_cache_free(asd_dma_token_cache, token);
256 static inline struct asd_dma_tok *asd_alloc_coherent(struct asd_ha_struct *
260 struct asd_dma_tok *token = asd_dmatok_alloc(flags);
263 token->vaddr = dma_alloc_coherent(&asd_ha->pcidev->dev,
268 asd_dmatok_free(token);
275 static inline void asd_free_coherent(struct asd_ha_struct *asd_ha,
276 struct asd_dma_tok *token)
279 dma_free_coherent(&asd_ha->pcidev->dev, token->size,
280 token->vaddr, token->dma_handle);
281 asd_dmatok_free(token);
285 static inline void asd_init_ascb(struct asd_ha_struct *asd_ha,
286 struct asd_ascb *ascb)
288 INIT_LIST_HEAD(&ascb->list);
289 ascb->scb = ascb->dma_scb.vaddr;
291 ascb->timer.function = NULL;
292 init_timer(&ascb->timer);
294 init_completion(&ascb->completion);
297 /* Must be called with the tc_index_lock held!
299 static inline void asd_tc_index_release(struct asd_seq_data *seq, int index)
301 seq->tc_index_array[index] = NULL;
302 clear_bit(index, seq->tc_index_bitmap);
305 /* Must be called with the tc_index_lock held!
307 static inline int asd_tc_index_get(struct asd_seq_data *seq, void *ptr)
311 index = find_first_zero_bit(seq->tc_index_bitmap,
312 seq->tc_index_bitmap_bits);
313 if (index == seq->tc_index_bitmap_bits)
316 seq->tc_index_array[index] = ptr;
317 set_bit(index, seq->tc_index_bitmap);
322 /* Must be called with the tc_index_lock held!
324 static inline void *asd_tc_index_find(struct asd_seq_data *seq, int index)
326 return seq->tc_index_array[index];
330 * asd_ascb_free -- free a single aSCB after is has completed
331 * @ascb: pointer to the aSCB of interest
333 * This frees an aSCB after it has been executed/completed by
336 static inline void asd_ascb_free(struct asd_ascb *ascb)
339 struct asd_ha_struct *asd_ha = ascb->ha;
342 BUG_ON(!list_empty(&ascb->list));
343 spin_lock_irqsave(&ascb->ha->seq.tc_index_lock, flags);
344 asd_tc_index_release(&ascb->ha->seq, ascb->tc_index);
345 spin_unlock_irqrestore(&ascb->ha->seq.tc_index_lock, flags);
346 dma_pool_free(asd_ha->scb_pool, ascb->dma_scb.vaddr,
347 ascb->dma_scb.dma_handle);
348 kmem_cache_free(asd_ascb_cache, ascb);
353 * asd_ascb_list_free -- free a list of ascbs
354 * @ascb_list: a list of ascbs
356 * This function will free a list of ascbs allocated by asd_ascb_alloc_list.
357 * It is used when say the scb queueing function returned QUEUE_FULL,
358 * and we do not need the ascbs any more.
360 static inline void asd_ascb_free_list(struct asd_ascb *ascb_list)
363 struct list_head *n, *pos;
365 __list_add(&list, ascb_list->list.prev, &ascb_list->list);
366 list_for_each_safe(pos, n, &list) {
368 asd_ascb_free(list_entry(pos, struct asd_ascb, list));
372 /* ---------- Function declarations ---------- */
374 int asd_init_hw(struct asd_ha_struct *asd_ha);
375 irqreturn_t asd_hw_isr(int irq, void *dev_id);
378 struct asd_ascb *asd_ascb_alloc_list(struct asd_ha_struct
382 int asd_post_ascb_list(struct asd_ha_struct *asd_ha, struct asd_ascb *ascb,
384 int asd_post_escb_list(struct asd_ha_struct *asd_ha, struct asd_ascb *ascb,
387 int asd_init_post_escbs(struct asd_ha_struct *asd_ha);
388 void asd_build_control_phy(struct asd_ascb *ascb, int phy_id, u8 subfunc);
389 void asd_control_led(struct asd_ha_struct *asd_ha, int phy_id, int op);
390 void asd_turn_led(struct asd_ha_struct *asd_ha, int phy_id, int op);
391 int asd_enable_phys(struct asd_ha_struct *asd_ha, const u8 phy_mask);
392 void asd_build_initiate_link_adm_task(struct asd_ascb *ascb, int phy_id,
395 void asd_ascb_timedout(unsigned long data);
396 int asd_chip_hardrst(struct asd_ha_struct *asd_ha);