iPXE
undirom.c
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301, USA.
18  */
19 
20 FILE_LICENCE ( GPL2_OR_LATER );
21 
22 #include <stdint.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <pxe.h>
26 #include <realmode.h>
27 #include <undirom.h>
28 
29 /** @file
30  *
31  * UNDI expansion ROMs
32  *
33  */
34 
35 /** List of all UNDI ROMs */
36 static LIST_HEAD ( undiroms );
37 
38 /**
39  * Parse PXE ROM ID structure
40  *
41  * @v undirom UNDI ROM
42  * @v pxeromid Offset within ROM to PXE ROM ID structure
43  * @ret rc Return status code
44  */
45 static int undirom_parse_pxeromid ( struct undi_rom *undirom,
46  unsigned int pxeromid ) {
47  struct undi_rom_id undi_rom_id;
48  unsigned int undiloader;
49 
50  DBGC ( undirom, "UNDIROM %p has PXE ROM ID at %04x:%04x\n", undirom,
51  undirom->rom_segment, pxeromid );
52 
53  /* Read PXE ROM ID structure and verify */
54  copy_from_real ( &undi_rom_id, undirom->rom_segment, pxeromid,
55  sizeof ( undi_rom_id ) );
57  DBGC ( undirom, "UNDIROM %p has bad PXE ROM ID signature "
58  "%08x\n", undirom, undi_rom_id.Signature );
59  return -EINVAL;
60  }
61 
62  /* Check for UNDI loader */
63  undiloader = undi_rom_id.UNDILoader;
64  if ( ! undiloader ) {
65  DBGC ( undirom, "UNDIROM %p has no UNDI loader\n", undirom );
66  return -EINVAL;
67  }
68 
69  /* Fill in UNDI ROM loader fields */
70  undirom->loader_entry.segment = undirom->rom_segment;
71  undirom->loader_entry.offset = undiloader;
72  undirom->code_size = undi_rom_id.CodeSize;
73  undirom->data_size = undi_rom_id.DataSize;
74 
75  DBGC ( undirom, "UNDIROM %p has UNDI loader at %04x:%04x "
76  "(code %04zx data %04zx)\n", undirom,
77  undirom->loader_entry.segment, undirom->loader_entry.offset,
78  undirom->code_size, undirom->data_size );
79  return 0;
80 }
81 
82 /**
83  * Parse PCI expansion header
84  *
85  * @v undirom UNDI ROM
86  * @v pcirheader Offset within ROM to PCI expansion header
87  */
88 static int undirom_parse_pcirheader ( struct undi_rom *undirom,
89  unsigned int pcirheader ) {
90  struct pcir_header pcir_header;
91 
92  DBGC ( undirom, "UNDIROM %p has PCI expansion header at %04x:%04x\n",
93  undirom, undirom->rom_segment, pcirheader );
94 
95  /* Read PCI expansion header and verify */
96  copy_from_real ( &pcir_header, undirom->rom_segment, pcirheader,
97  sizeof ( pcir_header ) );
99  DBGC ( undirom, "UNDIROM %p has bad PCI expansion header "
100  "signature %08x\n", undirom, pcir_header.signature );
101  return -EINVAL;
102  }
103 
104  /* Fill in UNDI ROM PCI device fields */
105  undirom->bus_type = PCI_NIC;
108 
109  DBGC ( undirom, "UNDIROM %p is for PCI devices %04x:%04x\n", undirom,
110  undirom->bus_id.pci.vendor_id, undirom->bus_id.pci.device_id );
111  return 0;
112 
113 }
114 
115 /**
116  * Probe UNDI ROM
117  *
118  * @v rom_segment ROM segment address
119  * @ret rc Return status code
120  */
121 static int undirom_probe ( unsigned int rom_segment ) {
122  struct undi_rom *undirom = NULL;
123  struct undi_rom_header romheader;
124  size_t rom_len;
125  unsigned int pxeromid;
126  unsigned int pcirheader;
127  int rc;
128 
129  /* Read expansion ROM header and verify */
130  copy_from_real ( &romheader, rom_segment, 0, sizeof ( romheader ) );
131  if ( romheader.Signature != ROM_SIGNATURE ) {
132  rc = -EINVAL;
133  goto err;
134  }
135  rom_len = ( romheader.ROMLength * 512 );
136 
137  /* Allocate memory for UNDI ROM */
138  undirom = zalloc ( sizeof ( *undirom ) );
139  if ( ! undirom ) {
140  DBG ( "Could not allocate UNDI ROM structure\n" );
141  rc = -ENOMEM;
142  goto err;
143  }
144  DBGC ( undirom, "UNDIROM %p trying expansion ROM at %04x:0000 "
145  "(%zdkB)\n", undirom, rom_segment, ( rom_len / 1024 ) );
146  undirom->rom_segment = rom_segment;
147 
148  /* Check for and parse PXE ROM ID */
149  pxeromid = romheader.PXEROMID;
150  if ( ! pxeromid ) {
151  DBGC ( undirom, "UNDIROM %p has no PXE ROM ID\n", undirom );
152  rc = -EINVAL;
153  goto err;
154  }
155  if ( pxeromid > rom_len ) {
156  DBGC ( undirom, "UNDIROM %p PXE ROM ID outside ROM\n",
157  undirom );
158  rc = -EINVAL;
159  goto err;
160  }
161  if ( ( rc = undirom_parse_pxeromid ( undirom, pxeromid ) ) != 0 )
162  goto err;
163 
164  /* Parse PCIR header, if present */
165  pcirheader = romheader.PCIRHeader;
166  if ( pcirheader )
167  undirom_parse_pcirheader ( undirom, pcirheader );
168 
169  /* Add to UNDI ROM list and return */
170  DBGC ( undirom, "UNDIROM %p registered\n", undirom );
171  list_add_tail ( &undirom->list, &undiroms );
172  return 0;
173 
174  err:
175  free ( undirom );
176  return rc;
177 }
178 
179 /**
180  * Create UNDI ROMs for all possible expansion ROMs
181  *
182  * @ret
183  */
184 static void undirom_probe_all_roms ( void ) {
185  static int probed = 0;
186  unsigned int rom_segment;
187 
188  /* Perform probe only once */
189  if ( probed )
190  return;
191 
192  DBG ( "Scanning for PXE expansion ROMs\n" );
193 
194  /* Scan through expansion ROM region at 512 byte intervals */
195  for ( rom_segment = 0xc000 ; rom_segment < 0x10000 ;
196  rom_segment += 0x20 ) {
197  undirom_probe ( rom_segment );
198  }
199 
200  probed = 1;
201 }
202 
203 /**
204  * Find UNDI ROM for PCI device
205  *
206  * @v vendor_id PCI vendor ID
207  * @v device_id PCI device ID
208  * @v rombase ROM base address, or 0 for any
209  * @ret undirom UNDI ROM, or NULL
210  */
211 struct undi_rom * undirom_find_pci ( unsigned int vendor_id,
212  unsigned int device_id,
213  unsigned int rombase ) {
214  struct undi_rom *undirom;
215 
217 
218  list_for_each_entry ( undirom, &undiroms, list ) {
219  if ( undirom->bus_type != PCI_NIC )
220  continue;
221  if ( undirom->bus_id.pci.vendor_id != vendor_id )
222  continue;
223  if ( undirom->bus_id.pci.device_id != device_id )
224  continue;
225  if ( rombase && ( ( undirom->rom_segment << 4 ) != rombase ) )
226  continue;
227  DBGC ( undirom, "UNDIROM %p matched PCI %04x:%04x (%08x)\n",
228  undirom, vendor_id, device_id, rombase );
229  return undirom;
230  }
231 
232  DBG ( "No UNDI ROM matched PCI %04x:%04x (%08x)\n",
233  vendor_id, device_id, rombase );
234  return NULL;
235 }
#define EINVAL
Invalid argument.
Definition: errno.h:428
unsigned int rom_segment
ROM segment address.
Definition: undirom.h:33
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
size_t code_size
Code segment size.
Definition: undirom.h:37
#define PCI_NIC
PCI network card.
Definition: pxe_api.h:1301
static LIST_HEAD(undiroms)
List of all UNDI ROMs.
UINT16_t DataSize
Minimum required data segment size.
Definition: pxe.h:165
An UNDI expansion ROM header.
Definition: pxe.h:120
UINT8_t ROMLength
ROM length in 512-byte blocks.
Definition: pxe.h:127
UINT16_t Signature
Signature.
Definition: pxe.h:125
uint16_t device_id
Definition: ib_mad.h:19
size_t data_size
Data segment size.
Definition: undirom.h:39
static int undirom_parse_pxeromid(struct undi_rom *undirom, unsigned int pxeromid)
Parse PXE ROM ID structure.
Definition: undirom.c:45
#define DBGC(...)
Definition: compiler.h:505
A PCI expansion header.
Definition: pxe.h:175
static int undirom_probe(unsigned int rom_segment)
Probe UNDI ROM.
Definition: undirom.c:121
An UNDI ROM.
Definition: undirom.h:29
unsigned int bus_type
Bus type.
Definition: undirom.h:44
UINT16_t UNDILoader
Offset to UNDI loader.
Definition: pxe.h:161
#define ENOMEM
Not enough space.
Definition: errno.h:534
uint8_t vendor_id[3]
Definition: ib_mad.h:22
An UNDI ROM ID structure.
Definition: pxe.h:140
UNDI expansion ROMs.
UINT16_t PCIRHeader
Offset of the PCI ROM structure.
Definition: pxe.h:133
uint32_t signature
Signature.
Definition: pxe.h:180
#define list_for_each_entry(pos, head, member)
Iterate over entries in a list.
Definition: list.h:420
#define list_add_tail(new, head)
Add a new entry to the tail of a list.
Definition: list.h:93
UINT16_t PXEROMID
Offset of the PXE ROM ID structure.
Definition: pxe.h:131
#define UNDI_ROM_ID_SIGNATURE
Signature for an UNDI ROM ID structure.
Definition: pxe.h:171
#define ROM_SIGNATURE
Signature for an expansion ROM.
Definition: pxe.h:137
unsigned int vendor_id
PCI vendor ID.
Definition: undirom.h:17
SEGOFF16_t loader_entry
UNDI loader entry point.
Definition: undirom.h:35
#define PCIR_SIGNATURE
Signature for an UNDI ROM ID structure.
Definition: pxe.h:188
struct list_head list
List of UNDI ROMs.
Definition: undirom.h:31
union undi_device_id bus_id
Device ID.
Definition: undirom.h:46
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:54
void * zalloc(size_t size)
Allocate cleared memory.
Definition: malloc.c:624
static int undirom_parse_pcirheader(struct undi_rom *undirom, unsigned int pcirheader)
Parse PCI expansion header.
Definition: undirom.c:88
uint16_t vendor_id
PCI vendor ID.
Definition: pxe.h:182
UINT16_t CodeSize
Minimum required code segment size.
Definition: pxe.h:167
unsigned int device_id
PCI device ID.
Definition: undirom.h:19
UINT32_t Signature
Signature.
Definition: pxe.h:145
#define copy_from_real
Definition: libkir.h:79
uint16_t device_id
PCI device ID.
Definition: pxe.h:184
FILE_LICENCE(GPL2_OR_LATER)
struct undi_pci_device_id pci
PCI device ID.
Definition: undirom.h:25
static void undirom_probe_all_roms(void)
Create UNDI ROMs for all possible expansion ROMs.
Definition: undirom.c:184
#define DBG(...)
Print a debugging message.
Definition: compiler.h:498
struct undi_rom * undirom_find_pci(unsigned int vendor_id, unsigned int device_id, unsigned int rombase)
Find UNDI ROM for PCI device.
Definition: undirom.c:211
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
String functions.