xref: /freebsd/sys/dev/ata/ata-pci.h (revision 54ebdd631db8c0bba2baab0155f603a8b5cf014a)
1 /*-
2  * Copyright (c) 2003 - 2008 S�ren Schmidt <sos@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer,
10  *    without modification, immediately at the beginning of the file.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 /* structure holding chipset config info */
30 struct ata_chip_id {
31     u_int32_t           chipid;
32     u_int8_t            chiprev;
33     int                 cfg1;
34     int                 cfg2;
35     u_int8_t            max_dma;
36     char                *text;
37 };
38 
39 /* structure describing a PCI ATA controller */
40 struct ata_pci_controller {
41     device_t            dev;
42     int                 r_type1;
43     int                 r_rid1;
44     struct resource     *r_res1;
45     int                 r_type2;
46     int                 r_rid2;
47     struct resource     *r_res2;
48     struct resource     *r_irq;
49     void                *handle;
50     struct ata_chip_id  *chip;
51     int                 channels;
52     int                 (*chipinit)(device_t);
53     int                 (*suspend)(device_t);
54     int                 (*resume)(device_t);
55     int                 (*allocate)(device_t);
56     int                 (*locking)(device_t, int);
57     void                (*reset)(device_t);
58     void                (*dmainit)(device_t);
59     void                (*setmode)(device_t, int);
60     struct {
61     void                (*function)(void *);
62     void                *argument;
63     } interrupt[8];     /* XXX SOS max ch# for now */
64 };
65 
66 /* structure for SATA connection update hotplug/hotswap support */
67 struct ata_connect_task {
68     struct task task;
69     device_t    dev;
70     int         action;
71 #define ATA_C_ATTACH    1
72 #define ATA_C_DETACH    2
73 };
74 
75 /* defines for known chipset PCI id's */
76 #define ATA_ACARD_ID            0x1191
77 #define ATA_ATP850              0x00021191
78 #define ATA_ATP850A             0x00041191
79 #define ATA_ATP850R             0x00051191
80 #define ATA_ATP860A             0x00061191
81 #define ATA_ATP860R             0x00071191
82 #define ATA_ATP865A             0x00081191
83 #define ATA_ATP865R             0x00091191
84 
85 #define ATA_ACER_LABS_ID        0x10b9
86 #define ATA_ALI_1533            0x153310b9
87 #define ATA_ALI_5229            0x522910b9
88 #define ATA_ALI_5281            0x528110b9
89 #define ATA_ALI_5287            0x528710b9
90 #define ATA_ALI_5288            0x528810b9
91 #define ATA_ALI_5289            0x528910b9
92 
93 #define ATA_AMD_ID              0x1022
94 #define ATA_AMD755              0x74011022
95 #define ATA_AMD756              0x74091022
96 #define ATA_AMD766              0x74111022
97 #define ATA_AMD768              0x74411022
98 #define ATA_AMD8111             0x74691022
99 #define ATA_AMD5536             0x209a1022
100 
101 #define ATA_ADAPTEC_ID          0x9005
102 #define ATA_ADAPTEC_1420        0x02419005
103 
104 #define ATA_ATI_ID              0x1002
105 #define ATA_ATI_IXP200          0x43491002
106 #define ATA_ATI_IXP300          0x43691002
107 #define ATA_ATI_IXP300_S1       0x436e1002
108 #define ATA_ATI_IXP400          0x43761002
109 #define ATA_ATI_IXP400_S1       0x43791002
110 #define ATA_ATI_IXP400_S2       0x437a1002
111 #define ATA_ATI_IXP600          0x438c1002
112 #define ATA_ATI_IXP600_S1       0x43801002
113 #define ATA_ATI_IXP700          0x439c1002
114 #define ATA_ATI_IXP700_S1       0x43901002
115 
116 #define ATA_CENATEK_ID          0x16ca
117 #define ATA_CENATEK_ROCKET      0x000116ca
118 
119 #define ATA_CYRIX_ID            0x1078
120 #define ATA_CYRIX_5530          0x01021078
121 
122 #define ATA_CYPRESS_ID          0x1080
123 #define ATA_CYPRESS_82C693      0xc6931080
124 
125 #define ATA_DEC_21150           0x00221011
126 #define ATA_DEC_21150_1         0x00231011
127 
128 #define ATA_HIGHPOINT_ID        0x1103
129 #define ATA_HPT366              0x00041103
130 #define ATA_HPT372              0x00051103
131 #define ATA_HPT302              0x00061103
132 #define ATA_HPT371              0x00071103
133 #define ATA_HPT374              0x00081103
134 
135 #define ATA_INTEL_ID            0x8086
136 #define ATA_I960RM              0x09628086
137 #define ATA_I82371FB            0x12308086
138 #define ATA_I82371SB            0x70108086
139 #define ATA_I82371AB            0x71118086
140 #define ATA_I82443MX            0x71998086
141 #define ATA_I82451NX            0x84ca8086
142 #define ATA_I82372FB            0x76018086
143 #define ATA_I82801AB            0x24218086
144 #define ATA_I82801AA            0x24118086
145 #define ATA_I82801BA            0x244a8086
146 #define ATA_I82801BA_1          0x244b8086
147 #define ATA_I82801CA            0x248a8086
148 #define ATA_I82801CA_1          0x248b8086
149 #define ATA_I82801DB            0x24cb8086
150 #define ATA_I82801DB_1          0x24ca8086
151 #define ATA_I82801EB            0x24db8086
152 #define ATA_I82801EB_S1         0x24d18086
153 #define ATA_I82801EB_R1         0x24df8086
154 #define ATA_I6300ESB            0x25a28086
155 #define ATA_I6300ESB_S1         0x25a38086
156 #define ATA_I6300ESB_R1         0x25b08086
157 #define ATA_I63XXESB2           0x269e8086
158 #define ATA_I63XXESB2_S1        0x26808086
159 #define ATA_I63XXESB2_S2        0x26818086
160 #define ATA_I63XXESB2_R1        0x26828086
161 #define ATA_I63XXESB2_R2        0x26838086
162 #define ATA_I82801FB            0x266f8086
163 #define ATA_I82801FB_S1         0x26518086
164 #define ATA_I82801FB_R1         0x26528086
165 #define ATA_I82801FBM           0x26538086
166 #define ATA_I82801GB            0x27df8086
167 #define ATA_I82801GB_S1         0x27c08086
168 #define ATA_I82801GB_AH         0x27c18086
169 #define ATA_I82801GB_R1         0x27c38086
170 #define ATA_I82801GBM_S1        0x27c48086
171 #define ATA_I82801GBM_AH        0x27c58086
172 #define ATA_I82801GBM_R1        0x27c68086
173 #define ATA_I82801HB_S1         0x28208086
174 #define ATA_I82801HB_AH6        0x28218086
175 #define ATA_I82801HB_R1         0x28228086
176 #define ATA_I82801HB_AH4        0x28248086
177 #define ATA_I82801HB_S2         0x28258086
178 #define ATA_I82801HBM           0x28508086
179 #define ATA_I82801HBM_S1        0x28288086
180 #define ATA_I82801HBM_S2        0x28298086
181 #define ATA_I82801HBM_S3        0x282a8086
182 #define ATA_I82801IB_S1         0x29208086
183 #define ATA_I82801IB_AH2        0x29218086
184 #define ATA_I82801IB_AH6        0x29228086
185 #define ATA_I82801IB_AH4        0x29238086
186 #define ATA_I82801IB_R1         0x29258086
187 #define ATA_I82801IB_S2         0x29268086
188 #define ATA_I82801JIB_S1        0x3a208086
189 #define ATA_I82801JIB_AH        0x3a228086
190 #define ATA_I82801JIB_R1        0x3a258086
191 #define ATA_I82801JIB_S2        0x3a268086
192 #define ATA_I82801JD_S1         0x3a008086
193 #define ATA_I82801JD_AH         0x3a028086
194 #define ATA_I82801JD_R1         0x3a058086
195 #define ATA_I82801JD_S2         0x3a068086
196 #define ATA_I31244              0x32008086
197 
198 #define ATA_ITE_ID              0x1283
199 #define ATA_IT8211F             0x82111283
200 #define ATA_IT8212F             0x82121283
201 #define ATA_IT8213F             0x82131283
202 
203 #define ATA_JMICRON_ID          0x197b
204 #define ATA_JMB360              0x2360197b
205 #define ATA_JMB361              0x2361197b
206 #define ATA_JMB363              0x2363197b
207 #define ATA_JMB365              0x2365197b
208 #define ATA_JMB366              0x2366197b
209 #define ATA_JMB368              0x2368197b
210 
211 #define ATA_MARVELL_ID          0x11ab
212 #define ATA_M88SX5040           0x504011ab
213 #define ATA_M88SX5041           0x504111ab
214 #define ATA_M88SX5080           0x508011ab
215 #define ATA_M88SX5081           0x508111ab
216 #define ATA_M88SX6041           0x604111ab
217 #define ATA_M88SX6081           0x608111ab
218 #define ATA_M88SX6101           0x610111ab
219 #define ATA_M88SX6121           0x612111ab
220 #define ATA_M88SX6145           0x614511ab
221 
222 #define ATA_MICRON_ID           0x1042
223 #define ATA_MICRON_RZ1000       0x10001042
224 #define ATA_MICRON_RZ1001       0x10011042
225 
226 #define ATA_NATIONAL_ID         0x100b
227 #define ATA_SC1100              0x0502100b
228 
229 #define ATA_NETCELL_ID          0x169c
230 #define ATA_NETCELL_SR          0x0044169c
231 
232 #define ATA_NVIDIA_ID           0x10de
233 #define ATA_NFORCE1             0x01bc10de
234 #define ATA_NFORCE2             0x006510de
235 #define ATA_NFORCE2_PRO         0x008510de
236 #define ATA_NFORCE2_PRO_S1      0x008e10de
237 #define ATA_NFORCE3             0x00d510de
238 #define ATA_NFORCE3_PRO         0x00e510de
239 #define ATA_NFORCE3_PRO_S1      0x00e310de
240 #define ATA_NFORCE3_PRO_S2      0x00ee10de
241 #define ATA_NFORCE_MCP04        0x003510de
242 #define ATA_NFORCE_MCP04_S1     0x003610de
243 #define ATA_NFORCE_MCP04_S2     0x003e10de
244 #define ATA_NFORCE_CK804        0x005310de
245 #define ATA_NFORCE_CK804_S1     0x005410de
246 #define ATA_NFORCE_CK804_S2     0x005510de
247 #define ATA_NFORCE_MCP51        0x026510de
248 #define ATA_NFORCE_MCP51_S1     0x026610de
249 #define ATA_NFORCE_MCP51_S2     0x026710de
250 #define ATA_NFORCE_MCP55        0x036e10de
251 #define ATA_NFORCE_MCP55_S1     0x037e10de
252 #define ATA_NFORCE_MCP55_S2     0x037f10de
253 #define ATA_NFORCE_MCP61        0x03ec10de
254 #define ATA_NFORCE_MCP61_S1     0x03e710de
255 #define ATA_NFORCE_MCP61_S2     0x03f610de
256 #define ATA_NFORCE_MCP61_S3     0x03f710de
257 #define ATA_NFORCE_MCP65        0x044810de
258 #define ATA_NFORCE_MCP67        0x056010de
259 #define ATA_NFORCE_MCP73        0x056c10de
260 #define ATA_NFORCE_MCP77        0x075910de
261 
262 #define ATA_PROMISE_ID          0x105a
263 #define ATA_PDC20246            0x4d33105a
264 #define ATA_PDC20262            0x4d38105a
265 #define ATA_PDC20263            0x0d38105a
266 #define ATA_PDC20265            0x0d30105a
267 #define ATA_PDC20267            0x4d30105a
268 #define ATA_PDC20268            0x4d68105a
269 #define ATA_PDC20269            0x4d69105a
270 #define ATA_PDC20270            0x6268105a
271 #define ATA_PDC20271            0x6269105a
272 #define ATA_PDC20275            0x1275105a
273 #define ATA_PDC20276            0x5275105a
274 #define ATA_PDC20277            0x7275105a
275 #define ATA_PDC20318            0x3318105a
276 #define ATA_PDC20319            0x3319105a
277 #define ATA_PDC20371            0x3371105a
278 #define ATA_PDC20375            0x3375105a
279 #define ATA_PDC20376            0x3376105a
280 #define ATA_PDC20377            0x3377105a
281 #define ATA_PDC20378            0x3373105a
282 #define ATA_PDC20379            0x3372105a
283 #define ATA_PDC20571            0x3571105a
284 #define ATA_PDC20575            0x3d75105a
285 #define ATA_PDC20579            0x3574105a
286 #define ATA_PDC20771            0x3570105a
287 #define ATA_PDC40518            0x3d18105a
288 #define ATA_PDC40519            0x3519105a
289 #define ATA_PDC40718            0x3d17105a
290 #define ATA_PDC40719            0x3515105a
291 #define ATA_PDC40775            0x3d73105a
292 #define ATA_PDC40779            0x3577105a
293 #define ATA_PDC20617            0x6617105a
294 #define ATA_PDC20618            0x6626105a
295 #define ATA_PDC20619            0x6629105a
296 #define ATA_PDC20620            0x6620105a
297 #define ATA_PDC20621            0x6621105a
298 #define ATA_PDC20622            0x6622105a
299 #define ATA_PDC20624            0x6624105a
300 #define ATA_PDC81518            0x8002105a
301 
302 #define ATA_SERVERWORKS_ID      0x1166
303 #define ATA_ROSB4_ISA           0x02001166
304 #define ATA_ROSB4               0x02111166
305 #define ATA_CSB5                0x02121166
306 #define ATA_CSB6                0x02131166
307 #define ATA_CSB6_1              0x02171166
308 #define ATA_HT1000              0x02141166
309 #define ATA_HT1000_S1           0x024b1166
310 #define ATA_HT1000_S2           0x024a1166
311 #define ATA_K2			0x02401166
312 #define ATA_FRODO4		0x02411166
313 #define ATA_FRODO8		0x02421166
314 
315 #define ATA_SILICON_IMAGE_ID    0x1095
316 #define ATA_SII3114             0x31141095
317 #define ATA_SII3512             0x35121095
318 #define ATA_SII3112             0x31121095
319 #define ATA_SII3112_1           0x02401095
320 #define ATA_SII3124		0x31241095
321 #define ATA_SII3132		0x31321095
322 #define ATA_SII3132_1		0x02421095
323 #define ATA_SII0680             0x06801095
324 #define ATA_CMD646              0x06461095
325 #define ATA_CMD648              0x06481095
326 #define ATA_CMD649              0x06491095
327 
328 #define ATA_SIS_ID              0x1039
329 #define ATA_SISSOUTH            0x00081039
330 #define ATA_SIS5511             0x55111039
331 #define ATA_SIS5513             0x55131039
332 #define ATA_SIS5517             0x55171039
333 #define ATA_SIS5518             0x55181039
334 #define ATA_SIS5571             0x55711039
335 #define ATA_SIS5591             0x55911039
336 #define ATA_SIS5596             0x55961039
337 #define ATA_SIS5597             0x55971039
338 #define ATA_SIS5598             0x55981039
339 #define ATA_SIS5600             0x56001039
340 #define ATA_SIS530              0x05301039
341 #define ATA_SIS540              0x05401039
342 #define ATA_SIS550              0x05501039
343 #define ATA_SIS620              0x06201039
344 #define ATA_SIS630              0x06301039
345 #define ATA_SIS635              0x06351039
346 #define ATA_SIS633              0x06331039
347 #define ATA_SIS640              0x06401039
348 #define ATA_SIS645              0x06451039
349 #define ATA_SIS646              0x06461039
350 #define ATA_SIS648              0x06481039
351 #define ATA_SIS650              0x06501039
352 #define ATA_SIS651              0x06511039
353 #define ATA_SIS652              0x06521039
354 #define ATA_SIS655              0x06551039
355 #define ATA_SIS658              0x06581039
356 #define ATA_SIS661              0x06611039
357 #define ATA_SIS730              0x07301039
358 #define ATA_SIS733              0x07331039
359 #define ATA_SIS735              0x07351039
360 #define ATA_SIS740              0x07401039
361 #define ATA_SIS745              0x07451039
362 #define ATA_SIS746              0x07461039
363 #define ATA_SIS748              0x07481039
364 #define ATA_SIS750              0x07501039
365 #define ATA_SIS751              0x07511039
366 #define ATA_SIS752              0x07521039
367 #define ATA_SIS755              0x07551039
368 #define ATA_SIS961              0x09611039
369 #define ATA_SIS962              0x09621039
370 #define ATA_SIS963              0x09631039
371 #define ATA_SIS964              0x09641039
372 #define ATA_SIS965              0x09651039
373 #define ATA_SIS180              0x01801039
374 #define ATA_SIS181              0x01811039
375 #define ATA_SIS182              0x01821039
376 
377 #define ATA_VIA_ID              0x1106
378 #define ATA_VIA82C571           0x05711106
379 #define ATA_VIA82C586           0x05861106
380 #define ATA_VIA82C596           0x05961106
381 #define ATA_VIA82C686           0x06861106
382 #define ATA_VIA8231             0x82311106
383 #define ATA_VIA8233             0x30741106
384 #define ATA_VIA8233A            0x31471106
385 #define ATA_VIA8233C            0x31091106
386 #define ATA_VIA8235             0x31771106
387 #define ATA_VIA8237             0x32271106
388 #define ATA_VIA8237A            0x05911106
389 #define ATA_VIA8237S		0x53371106
390 #define ATA_VIA8251             0x33491106
391 #define ATA_VIA8361             0x31121106
392 #define ATA_VIA8363             0x03051106
393 #define ATA_VIA8371             0x03911106
394 #define ATA_VIA8662             0x31021106
395 #define ATA_VIA6410             0x31641106
396 #define ATA_VIA6420             0x31491106
397 #define ATA_VIA6421             0x32491106
398 
399 /* global prototypes ata-pci.c */
400 int ata_pci_probe(device_t dev);
401 int ata_pci_attach(device_t dev);
402 int ata_pci_detach(device_t dev);
403 int ata_pci_suspend(device_t dev);
404 int ata_pci_resume(device_t dev);
405 struct resource * ata_pci_alloc_resource(device_t dev, device_t child, int type, int *rid, u_long start, u_long end, u_long count, u_int flags);
406 int ata_pci_release_resource(device_t dev, device_t child, int type, int rid, struct resource *r);
407 int ata_pci_setup_intr(device_t dev, device_t child, struct resource *irq, int flags, driver_filter_t *filter, driver_intr_t *function, void *argument, void **cookiep);
408  int ata_pci_teardown_intr(device_t dev, device_t child, struct resource *irq, void *cookie);
409 int ata_pci_allocate(device_t dev);
410 int ata_pci_status(device_t dev);
411 void ata_pci_hw(device_t dev);
412 void ata_pci_dmainit(device_t dev);
413 char *ata_pcivendor2str(device_t dev);
414 int ata_legacy(device_t);
415 void ata_generic_intr(void *data);
416 int ata_setup_interrupt(device_t dev, void *intr_func);
417 void ata_set_desc(device_t dev);
418 struct ata_chip_id *ata_match_chip(device_t dev, struct ata_chip_id *index);
419 struct ata_chip_id *ata_find_chip(device_t dev, struct ata_chip_id *index, int slot);
420 void ata_print_cable(device_t dev, u_int8_t *who);
421 int ata_check_80pin(device_t dev, int mode);
422 int ata_mode2idx(int mode);
423 
424 /* global prototypes ata-sata.c */
425 void ata_sata_phy_event(void *context, int dummy);
426 void ata_sata_phy_check_events(device_t dev);
427 int ata_sata_phy_reset(device_t dev);
428 void ata_sata_setmode(device_t dev, int mode);
429 int ata_request2fis_h2d(struct ata_request *request, u_int8_t *fis);
430 void ata_pm_identify(device_t dev);
431 
432 /* global prototypes from chipsets/ata-*.c */
433 int ata_ahci_chipinit(device_t);
434 int ata_ahci_allocate(device_t dev);
435 void ata_ahci_reset(device_t dev);
436 void ata_ahci_dmainit(device_t dev);
437 int ata_marvell_edma_chipinit(device_t);
438 int ata_sii_chipinit(device_t);
439 
440 /* global prototypes ata-dma.c */
441 void ata_dmainit(device_t);
442 
443 /* externs */
444 extern devclass_t ata_pci_devclass;
445 
446 /* macro for easy definition of all driver module stuff */
447 #define ATA_DECLARE_DRIVER(dname) \
448 static device_method_t __CONCAT(dname,_methods)[] = { \
449     DEVMETHOD(device_probe,     __CONCAT(dname,_probe)), \
450     DEVMETHOD(device_attach,    ata_pci_attach), \
451     DEVMETHOD(device_detach,    ata_pci_detach), \
452     DEVMETHOD(device_suspend,   ata_pci_suspend), \
453     DEVMETHOD(device_resume,    ata_pci_resume), \
454     DEVMETHOD(device_shutdown,  bus_generic_shutdown), \
455     DEVMETHOD(bus_alloc_resource,       ata_pci_alloc_resource), \
456     DEVMETHOD(bus_release_resource,     ata_pci_release_resource), \
457     DEVMETHOD(bus_activate_resource,    bus_generic_activate_resource), \
458     DEVMETHOD(bus_deactivate_resource,  bus_generic_deactivate_resource), \
459     DEVMETHOD(bus_setup_intr,           ata_pci_setup_intr), \
460     DEVMETHOD(bus_teardown_intr,        ata_pci_teardown_intr), \
461     { 0, 0 } \
462 }; \
463 static driver_t __CONCAT(dname,_driver) = { \
464         "atapci", \
465         __CONCAT(dname,_methods), \
466         sizeof(struct ata_pci_controller) \
467 }; \
468 DRIVER_MODULE(dname, pci, __CONCAT(dname,_driver), ata_pci_devclass, 0, 0); \
469 MODULE_VERSION(dname, 1); \
470 MODULE_DEPEND(dname, ata, 1, 1, 1); \
471 MODULE_DEPEND(dname, atapci, 1, 1, 1);
472 
473