ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[linux-2.6.git] / drivers / scsi / qla2xxx / qla_inline.h
1 /*
2  *                  QLOGIC LINUX SOFTWARE
3  *
4  * QLogic ISP2x00 device driver for Linux 2.6.x
5  * Copyright (C) 2003-2004 QLogic Corporation
6  * (www.qlogic.com)
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU General Public License as published by the
10  * Free Software Foundation; either version 2, or (at your option) any
11  * later version.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * General Public License for more details.
17  *
18  */
19
20
21 static __inline__ uint16_t qla2x00_debounce_register(volatile uint16_t *);
22 /*
23  * qla2x00_debounce_register
24  *      Debounce register.
25  *
26  * Input:
27  *      port = register address.
28  *
29  * Returns:
30  *      register value.
31  */
32 static __inline__ uint16_t
33 qla2x00_debounce_register(volatile uint16_t *addr) 
34 {
35         volatile uint16_t first;
36         volatile uint16_t second;
37
38         do {
39                 first = RD_REG_WORD(addr);
40                 barrier();
41                 cpu_relax();
42                 second = RD_REG_WORD(addr);
43         } while (first != second);
44
45         return (first);
46 }
47
48 static __inline__ int qla2x00_normalize_dma_addr(
49     dma_addr_t *e_addr,  uint32_t *e_len,
50     dma_addr_t *ne_addr, uint32_t *ne_len);
51
52 /**
53  * qla2x00_normalize_dma_addr() - Normalize an DMA address.
54  * @e_addr: Raw DMA address
55  * @e_len: Raw DMA length
56  * @ne_addr: Normalized second DMA address
57  * @ne_len: Normalized second DMA length
58  *
59  * If the address does not span a 4GB page boundary, the contents of @ne_addr
60  * and @ne_len are undefined.  @e_len is updated to reflect a normalization.
61  *
62  * Example:
63  *
64  *      ffffabc0ffffeeee        (e_addr) start of DMA address
65  *      0000000020000000        (e_len)  length of DMA transfer
66  *      ffffabc11fffeeed        end of DMA transfer
67  *
68  * Is the 4GB boundary crossed?
69  *
70  *      ffffabc0ffffeeee        (e_addr)
71  *      ffffabc11fffeeed        (e_addr + e_len - 1)
72  *      00000001e0000003        ((e_addr ^ (e_addr + e_len - 1))
73  *      0000000100000000        ((e_addr ^ (e_addr + e_len - 1)) & ~(0xffffffff)
74  *
75  * Compute start of second DMA segment:
76  *
77  *      ffffabc0ffffeeee        (e_addr)
78  *      ffffabc1ffffeeee        (0x100000000 + e_addr)
79  *      ffffabc100000000        (0x100000000 + e_addr) & ~(0xffffffff)
80  *      ffffabc100000000        (ne_addr)
81  *      
82  * Compute length of second DMA segment:
83  *
84  *      00000000ffffeeee        (e_addr & 0xffffffff)
85  *      0000000000001112        (0x100000000 - (e_addr & 0xffffffff))
86  *      000000001fffeeee        (e_len - (0x100000000 - (e_addr & 0xffffffff))
87  *      000000001fffeeee        (ne_len)
88  *
89  * Adjust length of first DMA segment
90  *
91  *      0000000020000000        (e_len)
92  *      0000000000001112        (e_len - ne_len)
93  *      0000000000001112        (e_len)
94  *
95  * Returns non-zero if the specified address was normalized, else zero.
96  */
97 static __inline__ int
98 qla2x00_normalize_dma_addr(
99     dma_addr_t *e_addr,  uint32_t *e_len,
100     dma_addr_t *ne_addr, uint32_t *ne_len)
101 {
102         int normalized;
103
104         normalized = 0;
105         if ((*e_addr ^ (*e_addr + *e_len - 1)) & ~(0xFFFFFFFFULL)) {
106                 /* Compute normalized crossed address and len */
107                 *ne_addr = (0x100000000ULL + *e_addr) & ~(0xFFFFFFFFULL);
108                 *ne_len = *e_len - (0x100000000ULL - (*e_addr & 0xFFFFFFFFULL));
109                 *e_len -= *ne_len;
110
111                 normalized++;
112         }
113         return (normalized);
114 }
115
116 static __inline__ void qla2x00_poll(scsi_qla_host_t *);
117 static inline void 
118 qla2x00_poll(scsi_qla_host_t *ha)
119 {
120         qla2x00_intr_handler(0, ha, NULL);
121 }
122
123
124 static __inline__ void qla2x00_enable_intrs(scsi_qla_host_t *);
125 static __inline__ void qla2x00_disable_intrs(scsi_qla_host_t *);
126
127 static inline void 
128 qla2x00_enable_intrs(scsi_qla_host_t *ha)
129 {
130         unsigned long flags = 0;
131         device_reg_t *reg;
132
133         spin_lock_irqsave(&ha->hardware_lock, flags);
134         reg = ha->iobase;
135         ha->interrupts_on = 1;
136         /* enable risc and host interrupts */
137         WRT_REG_WORD(&reg->ictrl, ICR_EN_INT | ICR_EN_RISC);
138         RD_REG_WORD(&reg->ictrl);
139         spin_unlock_irqrestore(&ha->hardware_lock, flags);
140
141 }
142
143 static inline void 
144 qla2x00_disable_intrs(scsi_qla_host_t *ha)
145 {
146         unsigned long flags = 0;
147         device_reg_t *reg;
148
149         spin_lock_irqsave(&ha->hardware_lock, flags);
150         reg = ha->iobase;
151         ha->interrupts_on = 0;
152         /* disable risc and host interrupts */
153         WRT_REG_WORD(&reg->ictrl, 0);
154         RD_REG_WORD(&reg->ictrl);
155         spin_unlock_irqrestore(&ha->hardware_lock, flags);
156 }
157
158
159 static __inline__ int qla2x00_is_wwn_zero(uint8_t *);
160
161 /*
162  * qla2x00_is_wwn_zero - Check for zero node name
163  *
164  * Input:
165  *      wwn = Pointer to WW name to check
166  *
167  * Returns:
168  *      TRUE if name is 0 else FALSE
169  *
170  * Context:
171  *      Kernel context.
172  */
173 static __inline__ int
174 qla2x00_is_wwn_zero(uint8_t *wwn)
175 {
176         int cnt;
177
178         for (cnt = 0; cnt < WWN_SIZE ; cnt++, wwn++) {
179                 if (*wwn != 0)
180                         break;
181         }
182         /* if zero return TRUE */
183         if (cnt == WWN_SIZE)
184                 return (1);
185         else
186                 return (0);
187 }
188
189 static __inline__ uint8_t
190 qla2x00_suspend_lun(scsi_qla_host_t *, os_lun_t *, int, int);
191 static __inline__ uint8_t
192 qla2x00_delay_lun(scsi_qla_host_t *, os_lun_t *, int);
193
194 static __inline__ uint8_t
195 qla2x00_suspend_lun(scsi_qla_host_t *ha, os_lun_t *lq, int time, int count)
196 {
197         return (__qla2x00_suspend_lun(ha, lq, time, count, 0));
198 }
199
200 static __inline__ uint8_t
201 qla2x00_delay_lun(scsi_qla_host_t *ha, os_lun_t *lq, int time)
202 {
203         return (__qla2x00_suspend_lun(ha, lq, time, 1, 1));
204 }
205
206 static __inline__ void qla2x00_check_fabric_devices(scsi_qla_host_t *);
207 /*
208  * This routine will wait for fabric devices for
209  * the reset delay.
210  */
211 static __inline__ void qla2x00_check_fabric_devices(scsi_qla_host_t *ha) 
212 {
213         uint16_t        fw_state;
214
215         qla2x00_get_firmware_state(ha, &fw_state);
216 }
217
218 /**
219  * qla2x00_issue_marker() - Issue a Marker IOCB if necessary.
220  * @ha: HA context
221  * @ha_locked: is function called with the hardware lock
222  *
223  * Returns non-zero if a failure occured, else zero.
224  */
225 static inline int
226 qla2x00_issue_marker(scsi_qla_host_t *ha, int ha_locked)
227 {
228         /* Send marker if required */
229         if (ha->marker_needed != 0) {
230                 if (ha_locked) {
231                         if (__qla2x00_marker(ha, 0, 0, MK_SYNC_ALL) !=
232                             QLA_SUCCESS)
233                                 return (QLA_FUNCTION_FAILED);
234                 } else {
235                         if (qla2x00_marker(ha, 0, 0, MK_SYNC_ALL) !=
236                             QLA_SUCCESS)
237                                 return (QLA_FUNCTION_FAILED);
238                 }
239                 ha->marker_needed = 0;
240         }
241         return (QLA_SUCCESS);
242 }
243
244 static __inline__ void qla2x00_add_timer_to_cmd(srb_t *, int);
245 static __inline__ void qla2x00_delete_timer_from_cmd(srb_t *);
246
247 /**************************************************************************
248 *   qla2x00_add_timer_to_cmd
249 *
250 * Description:
251 *       Creates a timer for the specified command. The timeout is usually
252 *       the command time from kernel minus 2 secs.
253 *
254 * Input:
255 *     sp - pointer to validate
256 *
257 * Returns:
258 *     None.
259 **************************************************************************/
260 static inline void
261 qla2x00_add_timer_to_cmd(srb_t *sp, int timeout)
262 {
263         init_timer(&sp->timer);
264         sp->timer.expires = jiffies + timeout * HZ;
265         sp->timer.data = (unsigned long) sp;
266         sp->timer.function = (void (*) (unsigned long))qla2x00_cmd_timeout;
267         add_timer(&sp->timer);
268 }
269
270 /**************************************************************************
271 *   qla2x00_delete_timer_from_cmd
272 *
273 * Description:
274 *       Delete the timer for the specified command.
275 *
276 * Input:
277 *     sp - pointer to validate
278 *
279 * Returns:
280 *     None.
281 **************************************************************************/
282 static inline void 
283 qla2x00_delete_timer_from_cmd(srb_t *sp)
284 {
285         if (sp->timer.function != NULL) {
286                 del_timer(&sp->timer);
287                 sp->timer.function =  NULL;
288                 sp->timer.data = (unsigned long) NULL;
289         }
290 }
291