Patch from andy yan <andyysj@gmail.com>:
[mirror/scst/.git] / mvsas_tgt / mv_sas.h
1 /*
2  * Marvell 88SE64xx/88SE94xx main function head file
3  *
4  * Copyright 2007 Red Hat, Inc.
5  * Copyright 2008 Marvell. <kewei@marvell.com>
6  *
7  * This file is licensed under GPLv2.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License as
11  * published by the Free Software Foundation; version 2 of the
12  * License.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
22  * USA
23 */
24
25 #ifndef _MV_SAS_H_
26 #define _MV_SAS_H_
27
28 #include <linux/kernel.h>
29 #include <linux/module.h>
30 #include <linux/spinlock.h>
31 #include <linux/delay.h>
32 #include <linux/types.h>
33 #include <linux/ctype.h>
34 #include <linux/dma-mapping.h>
35 #include <linux/pci.h>
36 #include <linux/platform_device.h>
37 #include <linux/interrupt.h>
38 #include <linux/irq.h>
39 #include <linux/vmalloc.h>
40 #include <scsi/libsas.h>
41 #include <scsi/scsi_tcq.h>
42 #include <scsi/sas_ata.h>
43 #include <linux/version.h>
44 #include "mv_defs.h"
45 #ifdef SUPPORT_TARGET
46 #include "mv_tgt.h"
47 #endif
48
49 #define DRV_NAME                "mvsas"
50 #define DRV_VERSION             "0.8.2"
51 #define _MV_DUMP                0
52 #define MVS_ID_NOT_MAPPED       0x7f
53 /* #define DISABLE_HOTPLUG_DMA_FIX */
54
55 #define WIDE_PORT_MAX_PHY               4
56 #define MV_DISABLE_NCQ  0
57 #define mv_printk(fmt, arg ...) \
58         printk(KERN_DEBUG"%s %d:" fmt, __FILE__, __LINE__, ## arg)
59 #ifdef MV_DEBUG
60 #define mv_dprintk(format, arg...)      \
61         printk(KERN_DEBUG"%s %d:" format, __FILE__, __LINE__, ## arg)
62 #else
63 #define mv_dprintk(format, arg...)
64 #endif
65 #define MV_MAX_U32                      0xffffffff
66
67 extern struct mvs_tgt_initiator mvs_tgt;
68 extern struct mvs_info *tgt_mvi;
69 extern const struct mvs_dispatch mvs_64xx_dispatch;
70 extern const struct mvs_dispatch mvs_94xx_dispatch;
71
72 #define bit(n) ((u32)1 << n)
73
74 #define for_each_phy(__lseq_mask, __mc, __lseq)                 \
75         for ((__mc) = (__lseq_mask), (__lseq) = 0;              \
76                                         (__mc) != 0 ;           \
77                                         (++__lseq), (__mc) >>= 1)
78
79 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 24)
80 #include <scsi.h>
81 #define sg_page(sg)     (sg->page)
82 #define for_each_sg(sglist, sg, nr, __i)        \
83         for (__i = 0, sg = (sglist); __i < (nr); __i++, sg++)
84 #endif
85 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 25)
86 #define SAS_PROTOCOL_ALL SAS_PROTO_ALL
87 #endif
88 #if LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 20)
89 #define MV_INIT_DELAYED_WORK(w, f, d)   INIT_DELAYED_WORK(w, f)
90 #else
91 #define MV_INIT_DELAYED_WORK(w, f, d)   INIT_DELAYED_WORK(w, f, (void *) d)
92 #endif
93
94 #define UNASSOC_D2H_FIS(id)             \
95         ((void *) mvi->rx_fis + 0x100 * id)
96 #define SATA_RECEIVED_FIS_LIST(reg_set) \
97         ((void *) mvi->rx_fis + mvi->chip->fis_offs + 0x100 * reg_set)
98 #define SATA_RECEIVED_SDB_FIS(reg_set)  \
99         (SATA_RECEIVED_FIS_LIST(reg_set) + 0x58)
100 #define SATA_RECEIVED_D2H_FIS(reg_set)  \
101         (SATA_RECEIVED_FIS_LIST(reg_set) + 0x40)
102 #define SATA_RECEIVED_PIO_FIS(reg_set)  \
103         (SATA_RECEIVED_FIS_LIST(reg_set) + 0x20)
104 #define SATA_RECEIVED_DMA_FIS(reg_set)  \
105         (SATA_RECEIVED_FIS_LIST(reg_set) + 0x00)
106
107 struct mvs_info;
108
109 struct mvs_dispatch {
110         char *name;
111         int (*chip_init)(struct mvs_info *mvi);
112         int (*spi_init)(struct mvs_info *mvi);
113         int (*chip_ioremap)(struct mvs_info *mvi);
114         void (*chip_iounmap)(struct mvs_info *mvi);
115         irqreturn_t (*isr)(struct mvs_info *mvi, int irq, u32 stat);
116         u32 (*isr_status)(struct mvs_info *mvi, int irq);
117         void (*interrupt_enable)(struct mvs_info *mvi);
118         void (*interrupt_disable)(struct mvs_info *mvi);
119
120         u32 (*read_phy_ctl)(struct mvs_info *mvi, u32 port);
121         void (*write_phy_ctl)(struct mvs_info *mvi, u32 port, u32 val);
122
123         u32 (*read_port_cfg_data)(struct mvs_info *mvi, u32 port);
124         void (*write_port_cfg_data)(struct mvs_info *mvi, u32 port, u32 val);
125         void (*write_port_cfg_addr)(struct mvs_info *mvi, u32 port, u32 addr);
126
127         u32 (*read_port_vsr_data)(struct mvs_info *mvi, u32 port);
128         void (*write_port_vsr_data)(struct mvs_info *mvi, u32 port, u32 val);
129         void (*write_port_vsr_addr)(struct mvs_info *mvi, u32 port, u32 addr);
130
131         u32 (*read_port_irq_stat)(struct mvs_info *mvi, u32 port);
132         void (*write_port_irq_stat)(struct mvs_info *mvi, u32 port, u32 val);
133
134         u32 (*read_port_irq_mask)(struct mvs_info *mvi, u32 port);
135         void (*write_port_irq_mask)(struct mvs_info *mvi, u32 port, u32 val);
136
137         void (*get_sas_addr)(void *buf, u32 buflen);
138         void (*command_active)(struct mvs_info *mvi, u32 slot_idx);
139         void (*issue_stop)(struct mvs_info *mvi, enum mvs_port_type type,
140                                 u32 tfs);
141         void (*start_delivery)(struct mvs_info *mvi, u32 tx);
142         u32 (*rx_update)(struct mvs_info *mvi);
143         void (*int_full)(struct mvs_info *mvi);
144         u8 (*assign_reg_set)(struct mvs_info *mvi, u8 *tfs);
145         void (*free_reg_set)(struct mvs_info *mvi, u8 *tfs);
146         u32 (*prd_size)(void);
147         u32 (*prd_count)(void);
148         void (*make_prd)(struct scatterlist *scatter, int nr, void *prd);
149         void (*detect_porttype)(struct mvs_info *mvi, int i);
150         int (*oob_done)(struct mvs_info *mvi, int i);
151         void (*fix_phy_info)(struct mvs_info *mvi, int i,
152                                 struct sas_identify_frame *id);
153         void (*phy_work_around)(struct mvs_info *mvi, int i);
154         void (*phy_set_link_rate)(struct mvs_info *mvi, u32 phy_id,
155                                 struct sas_phy_linkrates *rates);
156         u32 (*phy_max_link_rate)(void);
157         void (*phy_disable)(struct mvs_info *mvi, u32 phy_id);
158         void (*phy_enable)(struct mvs_info *mvi, u32 phy_id);
159         void (*phy_reset)(struct mvs_info *mvi, u32 phy_id, int hard);
160         void (*stp_reset)(struct mvs_info *mvi, u32 phy_id);
161 #ifdef SUPPORT_TARGET
162         void (*enable_target_mode)(struct mvs_info *mvi, u32 port);
163         void (*disable_target_mode)(struct mvs_info *mvi, u32 port);
164 #endif
165         void (*clear_active_cmds)(struct mvs_info *mvi);
166         u32 (*spi_read_data)(struct mvs_info *mvi);
167         void (*spi_write_data)(struct mvs_info *mvi, u32 data);
168         int (*spi_buildcmd)(struct mvs_info *mvi,
169                                                 u32      *dwCmd,
170                                                 u8       cmd,
171                                                 u8       read,
172                                                 u8       length,
173                                                 u32      addr
174                                                 );
175         int (*spi_issuecmd)(struct mvs_info *mvi, u32 cmd);
176         int (*spi_waitdataready)(struct mvs_info *mvi, u32 timeout);
177 #ifndef DISABLE_HOTPLUG_DMA_FIX
178         void (*dma_fix)(dma_addr_t buf_dma, int buf_len, int from, void *prd);
179 #endif
180
181 };
182
183 struct mvs_chip_info {
184         u32             n_host;
185         u32             n_phy;
186         u32             fis_offs;
187         u32             fis_count;
188         u32             srs_sz;
189         u32             slot_width;
190         const struct mvs_dispatch *dispatch;
191 };
192 #define MVS_CHIP_SLOT_SZ        (1U << mvi->chip->slot_width)
193 #define MVS_RX_FISL_SZ          \
194         (mvi->chip->fis_offs + (mvi->chip->fis_count * 0x100))
195 #define MVS_CHIP_DISP           (mvi->chip->dispatch)
196
197 struct mvs_err_info {
198         __le32                  flags;
199         __le32                  flags2;
200 };
201
202 struct mvs_cmd_hdr {
203         __le32                  flags;  /* PRD tbl len; SAS, SATA ctl */
204         __le32                  lens;   /* cmd, max resp frame len */
205         __le32                  tags;   /* targ port xfer tag; tag */
206         __le32                  data_len;       /* data xfer len */
207         __le64                  cmd_tbl;        /* command table address */
208         __le64                  open_frame;     /* open addr frame address */
209         __le64                  status_buf;     /* status buffer address */
210         __le64                  prd_tbl;                /* PRD tbl address */
211         __le32                  reserved[4];
212 };
213
214 struct mvs_port {
215         struct asd_sas_port     sas_port;
216         u8                      port_attached;
217         u8                      wide_port_phymap;
218         struct list_head        list;
219 };
220
221 struct mvs_phy {
222         struct mvs_info                 *mvi;
223         struct mvs_port         *port;
224         struct asd_sas_phy      sas_phy;
225         struct sas_identify     identify;
226         struct scsi_device      *sdev;
227         struct timer_list timer;
228         u64             dev_sas_addr;
229         u64             att_dev_sas_addr;
230         u32             att_dev_info;
231         u32             dev_info;
232         u32             phy_type;
233         u32             phy_status;
234         u32             irq_status;
235         u32             frame_rcvd_size;
236         u8              frame_rcvd[32];
237         u8              phy_attached;
238         u8              phy_mode;
239         u8              reserved[2];
240         u32             phy_event;
241         enum sas_linkrate       minimum_linkrate;
242         enum sas_linkrate       maximum_linkrate;
243 };
244
245 struct mvs_device {
246         enum sas_dev_type dev_type;
247         struct domain_device *sas_device;
248         u32 attached_phy;
249         u32 device_id;
250         u32 runing_req;
251         u8 taskfileset;
252         struct list_head                dev_entry;
253 };
254
255 struct mvs_slot_info {
256         struct list_head entry;
257         union {
258                 struct sas_task *task;
259                 void *tdata;
260         };
261         u32 n_elem;
262         u32 tx;
263         u32 slot_tag;
264
265         /* DMA buffer for storing cmd tbl, open addr frame, status buffer,
266          * and PRD table
267          */
268         void *buf;
269         dma_addr_t buf_dma;
270 #if _MV_DUMP
271         u32 cmd_size;
272 #endif
273 #ifdef SUPPORT_TARGET
274         u32 target_cmd_tag;
275         /* interrnal command if NULL */
276         void *slot_scst_cmd;
277         struct mvst_port *slot_tgt_port;
278 #endif
279         void *response;
280         struct mvs_port *port;
281         struct mvs_device       *device;
282         void *open_frame;
283 };
284
285 struct mvs_info {
286         unsigned long flags;
287
288         /* host-wide lock */
289         spinlock_t lock;
290
291         /* our device */
292         struct pci_dev *pdev;
293         struct device *dev;
294
295         /* enhanced mode registers */
296         void __iomem *regs;
297
298         /* peripheral or soc registers */
299         void __iomem *regs_ex;
300         u8 sas_addr[SAS_ADDR_SIZE];
301
302         /* SCSI/SAS glue */
303         struct sas_ha_struct *sas;
304         struct Scsi_Host *shost;
305
306         /* TX (delivery) DMA ring */
307         __le32 *tx;
308         dma_addr_t tx_dma;
309
310         /* cached next-producer idx */
311         u32 tx_prod;
312
313         /* RX (completion) DMA ring */
314         __le32  *rx;
315         dma_addr_t rx_dma;
316
317         /* RX consumer idx */
318         u32 rx_cons;
319
320         /* RX'd FIS area */
321         __le32 *rx_fis;
322         dma_addr_t rx_fis_dma;
323
324         /* DMA command header slots */
325         struct mvs_cmd_hdr *slot;
326         dma_addr_t slot_dma;
327
328         u32 chip_id;
329         const struct mvs_chip_info *chip;
330
331         int tags_num;
332         u8 tags[MVS_SLOTS >> 3];
333
334         /* further per-slot information */
335         struct mvs_phy phy[MVS_MAX_PHYS];
336         struct mvs_port port[MVS_MAX_PHYS];
337         u32 irq;
338         u32 id;
339         u64 sata_reg_set;
340         struct list_head *hba_list;
341         struct list_head soc_entry;
342         struct list_head wq_list;
343         unsigned long instance;
344 #ifdef SUPPORT_TARGET
345         unsigned long host_no;
346         struct mvst_tgt *tgt;
347         struct mvst_port tgt_port[MVS_MAX_PHYS];
348         struct list_head data_cmd_list;
349 #endif /* SUPPORT_TARGET */
350         u16 flashid;
351         u32 flashsize;
352         u32 flashsectSize;
353
354         void *addon;
355         struct mvs_device       devices[MVS_MAX_DEVICES];
356 #ifndef DISABLE_HOTPLUG_DMA_FIX
357         void *bulk_buffer;
358         dma_addr_t bulk_buffer_dma;
359 #define TRASH_BUCKET_SIZE       0x20000
360 #endif
361         struct mvs_slot_info slot_info[0];
362 };
363
364 struct mvs_prv_info{
365         u8 n_host;
366         u8 n_phy;
367         u16 reserve;
368         struct mvs_info *mvi[2];
369 };
370
371 struct mvs_wq {
372         struct delayed_work work_q;
373         struct mvs_info *mvi;
374         void *data;
375         int handler;
376         struct list_head entry;
377 };
378
379 struct mvs_task_exec_info {
380         struct sas_task *task;
381         struct mvs_cmd_hdr *hdr;
382         struct mvs_port *port;
383         u32 tag;
384         int n_elem;
385 };
386
387
388 /******************** function prototype *********************/
389 void mvs_get_sas_addr(void *buf, u32 buflen);
390 void mvs_tag_clear(struct mvs_info *mvi, u32 tag);
391 void mvs_tag_free(struct mvs_info *mvi, u32 tag);
392 void mvs_tag_set(struct mvs_info *mvi, unsigned int tag);
393 int mvs_tag_alloc(struct mvs_info *mvi, u32 *tag_out);
394 void mvs_tag_init(struct mvs_info *mvi);
395 void mvs_iounmap(void __iomem *regs);
396 int mvs_ioremap(struct mvs_info *mvi, int bar, int bar_ex);
397 void mvs_phys_reset(struct mvs_info *mvi, u32 phy_mask, int hard);
398 int mvs_phy_control(struct asd_sas_phy *sas_phy, enum phy_func func,
399                         void *funcdata);
400 void __devinit mvs_set_sas_addr(struct mvs_info *mvi, int port_id,
401                                 u32 off_lo, u32 off_hi, u64 sas_addr);
402 int mvs_slave_alloc(struct scsi_device *scsi_dev);
403 int mvs_slave_configure(struct scsi_device *sdev);
404 void mvs_scan_start(struct Scsi_Host *shost);
405 int mvs_scan_finished(struct Scsi_Host *shost, unsigned long time);
406 int mvs_queue_command(struct sas_task *task, const int num,
407                         gfp_t gfp_flags);
408 int mvs_abort_task(struct sas_task *task);
409 int mvs_abort_task_set(struct domain_device *dev, u8 *lun);
410 int mvs_clear_aca(struct domain_device *dev, u8 *lun);
411 int mvs_clear_task_set(struct domain_device *dev, u8 * lun);
412 void mvs_port_formed(struct asd_sas_phy *sas_phy);
413 void mvs_port_deformed(struct asd_sas_phy *sas_phy);
414 int mvs_dev_found(struct domain_device *dev);
415 void mvs_dev_gone(struct domain_device *dev);
416 int mvs_lu_reset(struct domain_device *dev, u8 *lun);
417 int mvs_slot_complete(struct mvs_info *mvi, u32 rx_desc, u32 flags);
418 int mvs_I_T_nexus_reset(struct domain_device *dev);
419 int mvs_query_task(struct sas_task *task);
420 void mvs_release_task(struct mvs_info *mvi, int phy_no,
421                         struct domain_device *dev);
422 void mvs_int_port(struct mvs_info *mvi, int phy_no, u32 events);
423 void mvs_update_phyinfo(struct mvs_info *mvi, int i, int get_st);
424 int mvs_int_rx(struct mvs_info *mvi, bool self_clear);
425 void mvs_hexdump(u32 size, u8 *data, u32 baseaddr);
426 #endif
427