treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 411
[linux-2.6-block.git] / drivers / scsi / aic94xx / aic94xx.h
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Aic94xx SAS/SATA driver header file.
4  *
5  * Copyright (C) 2005 Adaptec, Inc.  All rights reserved.
6  * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
7  *
8  * $Id: //depot/aic94xx/aic94xx.h#31 $
9  */
10
11 #ifndef _AIC94XX_H_
12 #define _AIC94XX_H_
13
14 #include <linux/slab.h>
15 #include <linux/ctype.h>
16 #include <scsi/libsas.h>
17
18 #define ASD_DRIVER_NAME         "aic94xx"
19 #define ASD_DRIVER_DESCRIPTION  "Adaptec aic94xx SAS/SATA driver"
20
21 #define asd_printk(fmt, ...)    printk(KERN_NOTICE ASD_DRIVER_NAME ": " fmt, ## __VA_ARGS__)
22
23 #ifdef ASD_ENTER_EXIT
24 #define ENTER  printk(KERN_NOTICE "%s: ENTER %s\n", ASD_DRIVER_NAME, \
25                 __func__)
26 #define EXIT   printk(KERN_NOTICE "%s: --EXIT %s\n", ASD_DRIVER_NAME, \
27                 __func__)
28 #else
29 #define ENTER
30 #define EXIT
31 #endif
32
33 #ifdef ASD_DEBUG
34 #define ASD_DPRINTK asd_printk
35 #else
36 #define ASD_DPRINTK(fmt, ...)
37 #endif
38
39 /* 2*ITNL timeout + 1 second */
40 #define AIC94XX_SCB_TIMEOUT  (5*HZ)
41
42 extern struct kmem_cache *asd_dma_token_cache;
43 extern struct kmem_cache *asd_ascb_cache;
44
45 static inline void asd_stringify_sas_addr(char *p, const u8 *sas_addr)
46 {
47         int i;
48         for (i = 0; i < SAS_ADDR_SIZE; i++, p += 2)
49                 snprintf(p, 3, "%02X", sas_addr[i]);
50         *p = '\0';
51 }
52
53 struct asd_ha_struct;
54 struct asd_ascb;
55
56 int  asd_read_ocm(struct asd_ha_struct *asd_ha);
57 int  asd_read_flash(struct asd_ha_struct *asd_ha);
58
59 int  asd_dev_found(struct domain_device *dev);
60 void asd_dev_gone(struct domain_device *dev);
61
62 void asd_invalidate_edb(struct asd_ascb *ascb, int edb_id);
63
64 int  asd_execute_task(struct sas_task *task, gfp_t gfp_flags);
65
66 void asd_set_dmamode(struct domain_device *dev);
67
68 /* ---------- TMFs ---------- */
69 int  asd_abort_task(struct sas_task *);
70 int  asd_abort_task_set(struct domain_device *, u8 *lun);
71 int  asd_clear_aca(struct domain_device *, u8 *lun);
72 int  asd_clear_task_set(struct domain_device *, u8 *lun);
73 int  asd_lu_reset(struct domain_device *, u8 *lun);
74 int  asd_I_T_nexus_reset(struct domain_device *dev);
75 int  asd_query_task(struct sas_task *);
76
77 /* ---------- Adapter and Port management ---------- */
78 int  asd_clear_nexus_port(struct asd_sas_port *port);
79 int  asd_clear_nexus_ha(struct sas_ha_struct *sas_ha);
80
81 /* ---------- Phy Management ---------- */
82 int  asd_control_phy(struct asd_sas_phy *phy, enum phy_func func, void *arg);
83
84 #endif