Standardised debug mechanism in place now.
[people/xl0/gpxe.git] / src / arch / i386 / core / pci_io.c
1 /*
2 ** Support for NE2000 PCI clones added David Monro June 1997
3 ** Generalised to other NICs by Ken Yap July 1997
4 **
5 ** Most of this is taken from:
6 **
7 ** /usr/src/linux/drivers/pci/pci.c
8 ** /usr/src/linux/include/linux/pci.h
9 ** /usr/src/linux/arch/i386/bios32.c
10 ** /usr/src/linux/include/linux/bios32.h
11 ** /usr/src/linux/drivers/net/ne.c
12 */
13 #include "etherboot.h"
14 #include "init.h"
15 #include "pci.h"
16 #include "pci_io.h"
17 #ifdef KEEP_IT_REAL
18 #include "realmode.h"
19 #endif
20
21 /* Macros for direct PCI access */
22 #define CONFIG_ADDRESS  0xcf8
23 #define CONFIG_DATA     0xcfc
24 #define CONFIG_CMD( pci, where ) \
25         ( 0x80000000 | (pci->busdevfn << 8) | (where & ~3) )
26
27 /* Signatures for PCI BIOS */
28 #define BIOS_SIG(a,b,c,d)       ( ( a<<0 ) + ( b<<8 ) + ( c<<16 ) + ( d<<24 ) )
29 #define PRINT_BIOS_SIG(x)       ( (x) & 0xff ), ( ( (x)>>8 ) & 0xff ), \
30                                 ( ( (x)>>16 ) & 0xff ),( ( (x)>>24 ) & 0xff )
31 #define BIOS32_SIGNATURE        BIOS_SIG ( '_', '3', '2', '_' )
32 #define PCI_SIGNATURE           BIOS_SIG ( 'P', 'C', 'I', ' ' )
33 #define PCI_SERVICE             BIOS_SIG ( '$', 'P', 'C', 'I' )
34
35 /* BIOS32 structure as found in PCI BIOS ROM */
36 struct bios32 {
37         unsigned long signature;        /* _32_ */
38         unsigned long entry;            /* 32 bit physical address */
39         unsigned char revision;         /* Revision level, 0 */
40         unsigned char length;           /* Length in paragraphs */
41         unsigned char checksum;         /* Should byte sum to zero */
42         unsigned char reserved[5];      /* Must be zero */
43 };
44
45 /* Values returned by BIOS32 service directory */
46 #define BIOS32_SERVICE_PRESENT          0x00
47 #define BIOS32_SERVICE_NOT_PRESENT      0x80
48 #define CF ( 1 << 0 )
49
50 /* PCI BIOS entry point */
51 #ifndef KEEP_IT_REAL
52 static unsigned long pcibios32_entry;
53 #endif
54 static int have_pcibios;
55
56 /* Macro for calling a 32-bit entry point with flat physical
57  * addresses.  Use in a statement such as
58  * __asm__ ( FLAT_FAR_CALL_ESI,
59  *           : <output registers>
60  *           : "S" ( entry_point ), <other input registers> );
61  */
62 #define FLAT_FAR_CALL_ESI "call _virt_to_phys\n\t" \
63                           "pushl %%cs\n\t" \
64                           "call *%%esi\n\t" \
65                           "cli\n\t" \
66                           "cld\n\t" \
67                           "call _phys_to_virt\n\t"
68
69 /*
70  * Functions for accessing PCI configuration space directly with type
71  * 1 accesses.
72  *
73  */
74
75 static inline int pcidirect_read_config_byte ( struct pci_device *pci,
76                                                unsigned int where,
77                                                uint8_t *value ) {
78     outl ( CONFIG_CMD ( pci, where ), CONFIG_ADDRESS );
79     *value = inb ( CONFIG_DATA + ( where & 3 ) );
80     return 0;
81 }
82
83 static inline int pcidirect_read_config_word ( struct pci_device *pci,
84                                                unsigned int where,
85                                                uint16_t *value ) {
86     outl ( CONFIG_CMD ( pci, where ), CONFIG_ADDRESS );
87     *value = inw ( CONFIG_DATA + ( where & 2 ) );
88     return 0;
89 }
90
91 static inline int pcidirect_read_config_dword ( struct pci_device *pci,
92                                                 unsigned int where,
93                                                 uint32_t *value ) {
94     outl ( CONFIG_CMD ( pci, where ), CONFIG_ADDRESS );
95     *value = inl ( CONFIG_DATA );
96     return 0;
97 }
98
99 static inline int pcidirect_write_config_byte ( struct pci_device *pci,
100                                                 unsigned int where,
101                                                 uint8_t value ) {
102     outl ( CONFIG_CMD ( pci, where ), CONFIG_ADDRESS );
103     outb ( value, CONFIG_DATA + ( where & 3 ) );
104     return 0;
105 }
106
107 static inline int pcidirect_write_config_word ( struct pci_device *pci,
108                                                 unsigned int where,
109                                                 uint16_t value ) {
110     outl ( CONFIG_CMD ( pci, where ), CONFIG_ADDRESS );
111     outw ( value, CONFIG_DATA + ( where & 2 ) );
112     return 0;
113 }
114
115 static inline int pcidirect_write_config_dword ( struct pci_device *pci,
116                                                  unsigned int where,
117                                                  uint32_t value ) {
118     outl ( CONFIG_CMD ( pci, where ), CONFIG_ADDRESS );
119     outl ( value, CONFIG_DATA );
120     return 0;
121 }
122
123 /*
124  * Functions for accessing PCI configuration space directly via the
125  * PCI BIOS.
126  *
127  * Under -DKEEP_IT_REAL, we use INT 1A, otherwise we use the BIOS32
128  * interface.
129  */
130
131 #ifdef KEEP_IT_REAL
132
133 static void find_pcibios16 ( void ) {
134         uint16_t present;
135         uint32_t signature;
136         uint16_t flags;
137         uint16_t revision;
138
139         /* PCI BIOS installation check */
140         REAL_EXEC ( rm_pcibios_check,
141                     "int $0x1a\n\t"
142                     "pushfw\n\t"
143                     "popw %%cx\n\t",
144                     4,
145                     OUT_CONSTRAINTS ( "=a" ( present ), "=b" ( revision ),
146                                       "=c" ( flags ), "=d" ( signature ) ),
147                     IN_CONSTRAINTS ( "a" ( ( PCIBIOS_PCI_FUNCTION_ID << 8 ) +
148                                            PCIBIOS_PCI_BIOS_PRESENT ) ),
149                     CLOBBER ( "esi", "edi", "ebp" ) );
150
151         if ( ( flags & CF ) ||
152              ( ( present >> 8 ) != 0 ) ||
153              ( signature != PCI_SIGNATURE ) ) {
154                 DBG ( "PCI BIOS installation check failed\n" );
155                 return;
156         }
157
158         /* We have a PCI BIOS */
159         DBG ( "Found 16-bit PCI BIOS interface\n" );
160         have_pcibios = 1;
161         return;
162 }
163
164 INIT_FN ( INIT_PCIBIOS, find_pcibios16, NULL, NULL );
165
166 #define pcibios16_read_write( command, pci, where, value )              \
167         ( {                                                             \
168                 uint32_t discard_b, discard_D;                          \
169                 uint16_t ret;                                           \
170                                                                         \
171                 REAL_EXEC ( 999, /* need a local label */               \
172                             "int $0x1a\n\t"                             \
173                             "jc 1f\n\t"                                 \
174                             "xorw %%ax, %%ax\n\t"                       \
175                             "\n1:\n\t",                                 \
176                             5,                                          \
177                             OUT_CONSTRAINTS ( "=a" ( ret ),             \
178                                               "=b" ( discard_b ),       \
179                                               "=c" ( value ),           \
180                                               "=D" ( discard_D ) ),     \
181                             IN_CONSTRAINTS ( "a" ( command +            \
182                                     ( PCIBIOS_PCI_FUNCTION_ID << 8 ) ), \
183                                              "b" ( pci->busdevfn ),     \
184                                              "c" ( value ),             \
185                                              "D" ( where ) ),           \
186                             CLOBBER ( "edx", "esi", "ebp" ) );          \
187                                                                         \
188                 ( ret >> 8 );                                           \
189         } )
190 #define pcibios_read_write pcibios16_read_write
191
192 #else /* KEEP_IT_REAL */
193
194 /*
195  * Locate the BIOS32 service directory by scanning for a valid BIOS32
196  * structure
197  *
198  */
199 static struct bios32 * find_bios32 ( void ) {
200         uint32_t address;
201
202         /*
203          * Follow the standard procedure for locating the BIOS32 Service
204          * directory by scanning the permissible address range from
205          * 0xe0000 through 0xfffff for a valid BIOS32 structure.
206          *
207          */
208         for ( address = 0xe0000 ; address < 0xffff0 ; address += 16 ) {
209                 struct bios32 * candidate = phys_to_virt ( address );
210                 unsigned int length, i;
211                 unsigned char sum;
212
213                 if ( candidate->signature != BIOS32_SIGNATURE )
214                         continue;
215
216                 length = candidate->length * 16;
217                 if ( ! length )
218                         continue;
219
220                 for ( sum = 0, i = 0 ; i < length ; i++ )
221                         sum += ( ( char * ) candidate ) [i];
222                 if ( sum != 0 )
223                         continue;
224
225                 if ( candidate->revision != 0 ) {
226                         DBG ( "unsupported BIOS32 revision %d at %#x\n",
227                               candidate->revision, address );
228                         continue;
229                 }
230
231                 DBG ( "BIOS32 Service Directory structure at %#x\n", address );
232
233                 return candidate;
234         }
235
236         return NULL;
237 }
238
239 /*
240  * Look up a service in the BIOS32 service directory
241  *
242  */
243 static unsigned long find_bios32_service ( struct bios32 * bios32,
244                                            unsigned long service ) {
245         uint8_t return_code;
246         uint32_t address;
247         uint32_t length;
248         uint32_t entry;
249         uint32_t discard;
250
251         __asm__ ( FLAT_FAR_CALL_ESI
252                   : "=a" ( return_code ), "=b" ( address ),
253                     "=c" ( length ), "=d" ( entry ), "=S" ( discard )
254                   : "a" ( service ), "b" ( 0 ), "S" ( bios32->entry )
255                   : "edi", "ebp" );
256
257         switch ( return_code ) {
258         case BIOS32_SERVICE_PRESENT:
259                 DBG ( "BIOS32 service %c%c%c%c present at %#x\n",
260                       PRINT_BIOS_SIG ( service ), ( address + entry ) );
261                 return ( address + entry );
262         case BIOS32_SERVICE_NOT_PRESENT:
263                 DBG ( "BIOS32 service %c%c%c%c : not present\n",
264                       PRINT_BIOS_SIG ( service ) );
265                 return 0;
266         default: /* Shouldn't happen */
267                 DBG ( "BIOS32 returned %#x for service %c%c%c%c!\n",
268                       return_code, PRINT_BIOS_SIG ( service ) );
269                 return 0;
270         }
271 }
272
273 /*
274  * Find the 32-bit PCI BIOS interface, if present.
275  *
276  */
277 static void find_pcibios32 ( void ) {
278         struct bios32 *bios32;
279         uint32_t signature;
280         uint16_t present;
281         uint32_t flags;
282         uint16_t revision;
283         uint32_t discard;
284
285         /* Locate BIOS32 service directory */
286         bios32 = find_bios32 ();
287         if ( ! bios32 ) {
288                 DBG ( "No BIOS32\n" );
289                 return;
290         }
291
292         /* Locate PCI BIOS service */
293         pcibios32_entry = find_bios32_service ( bios32, PCI_SERVICE );
294         if ( ! pcibios32_entry ) {
295                 DBG ( "No PCI BIOS\n" );
296                 return;
297         }
298         
299         /* PCI BIOS installation check */
300         __asm__ ( FLAT_FAR_CALL_ESI
301                   "pushfl\n\t"
302                   "popl %%ecx\n\t"
303                   : "=a" ( present ), "=b" ( revision ), "=c" ( flags ),
304                     "=d" ( signature ), "=S" ( discard )
305                   : "a" ( ( PCIBIOS_PCI_FUNCTION_ID << 8 )
306                           + PCIBIOS_PCI_BIOS_PRESENT ),
307                     "S" ( pcibios32_entry )
308                   : "edi", "ebp" );
309
310         if ( ( flags & CF ) ||
311              ( ( present >> 8 ) != 0 ) ||
312              ( signature != PCI_SIGNATURE ) ) {
313                 DBG ( "PCI BIOS installation check failed\n" );
314                 return;
315         }
316
317         /* We have a PCI BIOS */
318         DBG ( "Found 32-bit PCI BIOS interface at %#x\n", pcibios32_entry );
319         have_pcibios = 1;
320         return;
321 }
322
323 INIT_FN ( INIT_PCIBIOS, find_pcibios32, NULL, NULL );
324
325 #define pcibios32_read_write( command, pci, where, value )              \
326         ( {                                                             \
327                 uint32_t discard_b, discard_D, discard_S;               \
328                 uint16_t ret;                                           \
329                                                                         \
330                 __asm__ ( FLAT_FAR_CALL_ESI                             \
331                           "jc 1f\n\t"                                   \
332                           "xorl %%eax, %%eax\n\t"                       \
333                           "\n1:\n\t"                                    \
334                           : "=a" ( ret ), "=b" ( discard_b ),           \
335                             "=c" ( value ),                             \
336                             "=S" ( discard_S ), "=D" ( discard_D )      \
337                           : "a" ( ( PCIBIOS_PCI_FUNCTION_ID << 8 )      \
338                                   + command ),                          \
339                             "b" ( pci->busdevfn ), "c" ( value ),       \
340                             "D" ( where ), "S" ( pcibios32_entry )      \
341                           : "edx", "ebp" );                             \
342                                                                         \
343                 ( ret >> 8 );                                           \
344         } )
345 #define pcibios_read_write pcibios32_read_write
346
347 #endif /* KEEP_IT_REAL */
348
349 static inline int pcibios_read_config_byte ( struct pci_device *pci,
350                                              unsigned int where,
351                                              uint8_t *value ) {
352         return pcibios_read_write ( PCIBIOS_READ_CONFIG_BYTE,
353                                     pci, where, *value );
354 }
355
356 static inline int pcibios_read_config_word ( struct pci_device *pci,
357                                              unsigned int where,
358                                              uint16_t *value ) {
359         return pcibios_read_write ( PCIBIOS_READ_CONFIG_WORD,
360                                     pci, where, *value );
361 }
362
363 static inline int pcibios_read_config_dword ( struct pci_device *pci,
364                                               unsigned int where,
365                                               uint32_t *value ) {
366         return pcibios_read_write ( PCIBIOS_READ_CONFIG_DWORD,
367                                     pci, where, *value );
368 }
369
370 static inline int pcibios_write_config_byte ( struct pci_device *pci,
371                                               unsigned int where,
372                                               uint8_t value ) {
373         return pcibios_read_write ( PCIBIOS_WRITE_CONFIG_BYTE,
374                                     pci, where, value );
375 }
376
377 static inline int pcibios_write_config_word ( struct pci_device *pci,
378                                               unsigned int where,
379                                               uint16_t value ) {
380         return pcibios_read_write ( PCIBIOS_WRITE_CONFIG_WORD,
381                                     pci, where, value );
382 }
383
384 static inline int pcibios_write_config_dword ( struct pci_device *pci,
385                                                unsigned int where,
386                                                uint32_t value ) {
387         return pcibios_read_write ( PCIBIOS_WRITE_CONFIG_DWORD,
388                                     pci, where, value );
389 }
390
391 /*
392  * Functions for accessing PCI configuration space via the PCI BIOS if
393  * present, otherwise directly via type 1 accesses.
394  *
395  */
396
397 int pci_read_config_byte ( struct pci_device *pci, unsigned int where,
398                            uint8_t *value ) {
399         return have_pcibios ?
400                 pcibios_read_config_byte ( pci, where, value ) :
401                 pcidirect_read_config_byte ( pci, where, value );
402 }
403                 
404 int pci_read_config_word ( struct pci_device *pci, unsigned int where,
405                            uint16_t *value ) {
406         return have_pcibios ?
407                 pcibios_read_config_word ( pci, where, value ) :
408                 pcidirect_read_config_word ( pci, where, value );
409 }
410                 
411 int pci_read_config_dword ( struct pci_device *pci, unsigned int where,
412                             uint32_t *value ) {
413         return have_pcibios ?
414                 pcibios_read_config_dword ( pci, where, value ) :
415                 pcidirect_read_config_dword ( pci, where, value );
416 }
417                 
418 int pci_write_config_byte ( struct pci_device *pci, unsigned int where,
419                             uint8_t value ) {
420         return have_pcibios ?
421                 pcibios_write_config_byte ( pci, where, value ) :
422                 pcidirect_write_config_byte ( pci, where, value );
423 }
424                 
425 int pci_write_config_word ( struct pci_device *pci, unsigned int where,
426                             uint16_t value ) {
427         return have_pcibios ?
428                 pcibios_write_config_word ( pci, where, value ) :
429                 pcidirect_write_config_word ( pci, where, value );
430 }
431                 
432 int pci_write_config_dword ( struct pci_device *pci, unsigned int where,
433                              uint32_t value ) {
434         return have_pcibios ?
435                 pcibios_write_config_dword ( pci, where, value ) :
436                 pcidirect_write_config_dword ( pci, where, value );
437 }
438                 
439 unsigned long pci_bus_base ( struct pci_device *pci __unused ) {
440         /* architecturally this must be 0 */
441         return 0;
442 }