2008-07-07 Stan Shebs <stan@codesourcery.com>
[binutils.git] / bfd / ppcboot.c
blobb4b6e7a2a8ed414bb2118c3442f1fe321ff701a3
1 /* BFD back-end for PPCbug boot records.
2 Copyright 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2006,
3 2007 Free Software Foundation, Inc.
4 Written by Michael Meissner, Cygnus Support, <meissner@cygnus.com>
6 This file is part of BFD, the Binary File Descriptor library.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 MA 02110-1301, USA. */
24 /* This is a BFD backend which may be used to write PowerPCBug boot objects.
25 It may only be used for output, not input. The intention is that this may
26 be used as an output format for objcopy in order to generate raw binary
27 data.
29 This is very simple. The only complication is that the real data
30 will start at some address X, and in some cases we will not want to
31 include X zeroes just to get to that point. Since the start
32 address is not meaningful for this object file format, we use it
33 instead to indicate the number of zeroes to skip at the start of
34 the file. objcopy cooperates by specially setting the start
35 address to zero by default. */
37 #include "sysdep.h"
38 #include "safe-ctype.h"
39 #include "bfd.h"
40 #include "libbfd.h"
42 /* PPCbug location structure */
43 typedef struct ppcboot_location {
44 bfd_byte ind;
45 bfd_byte head;
46 bfd_byte sector;
47 bfd_byte cylinder;
48 } ppcboot_location_t;
50 /* PPCbug partition table layout */
51 typedef struct ppcboot_partition {
52 ppcboot_location_t partition_begin; /* partition begin */
53 ppcboot_location_t partition_end; /* partition end */
54 bfd_byte sector_begin[4]; /* 32-bit start RBA (zero-based), little endian */
55 bfd_byte sector_length[4]; /* 32-bit RBA count (one-based), little endian */
56 } ppcboot_partition_t;
58 /* PPCbug boot layout. */
59 typedef struct ppcboot_hdr {
60 bfd_byte pc_compatibility[446]; /* x86 instruction field */
61 ppcboot_partition_t partition[4]; /* partition information */
62 bfd_byte signature[2]; /* 0x55 and 0xaa */
63 bfd_byte entry_offset[4]; /* entry point offset, little endian */
64 bfd_byte length[4]; /* load image length, little endian */
65 bfd_byte flags; /* flag field */
66 bfd_byte os_id; /* OS_ID */
67 char partition_name[32]; /* partition name */
68 bfd_byte reserved1[470]; /* reserved */
70 #ifdef __GNUC__
71 __attribute__ ((packed))
72 #endif
73 ppcboot_hdr_t;
75 /* Signature bytes for last 2 bytes of the 512 byte record */
76 #define SIGNATURE0 0x55
77 #define SIGNATURE1 0xaa
79 /* PowerPC boot type */
80 #define PPC_IND 0x41
82 /* Information needed for ppcboot header */
83 typedef struct ppcboot_data {
84 ppcboot_hdr_t header; /* raw header */
85 asection *sec; /* single section */
86 } ppcboot_data_t;
88 /* Any bfd we create by reading a ppcboot file has three symbols:
89 a start symbol, an end symbol, and an absolute length symbol. */
90 #define PPCBOOT_SYMS 3
92 static bfd_boolean ppcboot_mkobject PARAMS ((bfd *));
93 static const bfd_target *ppcboot_object_p PARAMS ((bfd *));
94 static bfd_boolean ppcboot_set_arch_mach
95 PARAMS ((bfd *, enum bfd_architecture, unsigned long));
96 static bfd_boolean ppcboot_get_section_contents
97 PARAMS ((bfd *, asection *, PTR, file_ptr, bfd_size_type));
98 static long ppcboot_get_symtab_upper_bound PARAMS ((bfd *));
99 static char *mangle_name PARAMS ((bfd *, char *));
100 static long ppcboot_canonicalize_symtab PARAMS ((bfd *, asymbol **));
101 static void ppcboot_get_symbol_info PARAMS ((bfd *, asymbol *, symbol_info *));
102 static bfd_boolean ppcboot_set_section_contents
103 PARAMS ((bfd *, asection *, const PTR, file_ptr, bfd_size_type));
104 static bfd_boolean ppcboot_bfd_print_private_bfd_data PARAMS ((bfd *, PTR));
106 #define ppcboot_set_tdata(abfd, ptr) ((abfd)->tdata.any = (PTR) (ptr))
107 #define ppcboot_get_tdata(abfd) ((ppcboot_data_t *) ((abfd)->tdata.any))
109 /* Create a ppcboot object. Invoked via bfd_set_format. */
111 static bfd_boolean
112 ppcboot_mkobject (abfd)
113 bfd *abfd;
115 if (!ppcboot_get_tdata (abfd))
117 bfd_size_type amt = sizeof (ppcboot_data_t);
118 ppcboot_set_tdata (abfd, bfd_zalloc (abfd, amt));
121 return TRUE;
125 /* Set the architecture to PowerPC */
126 static bfd_boolean
127 ppcboot_set_arch_mach (abfd, arch, machine)
128 bfd *abfd;
129 enum bfd_architecture arch;
130 unsigned long machine;
132 if (arch == bfd_arch_unknown)
133 arch = bfd_arch_powerpc;
135 else if (arch != bfd_arch_powerpc)
136 return FALSE;
138 return bfd_default_set_arch_mach (abfd, arch, machine);
142 /* Any file may be considered to be a ppcboot file, provided the target
143 was not defaulted. That is, it must be explicitly specified as
144 being ppcboot. */
146 static const bfd_target *
147 ppcboot_object_p (abfd)
148 bfd *abfd;
150 struct stat statbuf;
151 asection *sec;
152 ppcboot_hdr_t hdr;
153 size_t i;
154 ppcboot_data_t *tdata;
155 flagword flags;
157 BFD_ASSERT (sizeof (ppcboot_hdr_t) == 1024);
159 if (abfd->target_defaulted)
161 bfd_set_error (bfd_error_wrong_format);
162 return NULL;
165 /* Find the file size. */
166 if (bfd_stat (abfd, &statbuf) < 0)
168 bfd_set_error (bfd_error_system_call);
169 return NULL;
172 if ((size_t) statbuf.st_size < sizeof (ppcboot_hdr_t))
174 bfd_set_error (bfd_error_wrong_format);
175 return NULL;
178 if (bfd_bread ((PTR) &hdr, (bfd_size_type) sizeof (hdr), abfd)
179 != sizeof (hdr))
181 if (bfd_get_error () != bfd_error_system_call)
182 bfd_set_error (bfd_error_wrong_format);
184 return NULL;
187 /* Now do some basic checks. */
188 for (i = 0; i < sizeof (hdr.pc_compatibility); i++)
189 if (hdr.pc_compatibility[i])
191 bfd_set_error (bfd_error_wrong_format);
192 return NULL;
195 if (hdr.signature[0] != SIGNATURE0 || hdr.signature[1] != SIGNATURE1)
197 bfd_set_error (bfd_error_wrong_format);
198 return NULL;
201 if (hdr.partition[0].partition_end.ind != PPC_IND)
203 bfd_set_error (bfd_error_wrong_format);
204 return NULL;
207 abfd->symcount = PPCBOOT_SYMS;
209 /* One data section. */
210 flags = SEC_ALLOC | SEC_LOAD | SEC_DATA | SEC_CODE | SEC_HAS_CONTENTS;
211 sec = bfd_make_section_with_flags (abfd, ".data", flags);
212 if (sec == NULL)
213 return NULL;
214 sec->vma = 0;
215 sec->size = statbuf.st_size - sizeof (ppcboot_hdr_t);
216 sec->filepos = sizeof (ppcboot_hdr_t);
218 ppcboot_mkobject (abfd);
219 tdata = ppcboot_get_tdata (abfd);
220 tdata->sec = sec;
221 memcpy ((PTR) &tdata->header, (PTR) &hdr, sizeof (ppcboot_hdr_t));
223 ppcboot_set_arch_mach (abfd, bfd_arch_powerpc, 0L);
224 return abfd->xvec;
227 #define ppcboot_close_and_cleanup _bfd_generic_close_and_cleanup
228 #define ppcboot_bfd_free_cached_info _bfd_generic_bfd_free_cached_info
229 #define ppcboot_new_section_hook _bfd_generic_new_section_hook
232 /* Get contents of the only section. */
234 static bfd_boolean
235 ppcboot_get_section_contents (abfd, section, location, offset, count)
236 bfd *abfd;
237 asection *section ATTRIBUTE_UNUSED;
238 PTR location;
239 file_ptr offset;
240 bfd_size_type count;
242 if (bfd_seek (abfd, offset + (file_ptr) sizeof (ppcboot_hdr_t), SEEK_SET) != 0
243 || bfd_bread (location, count, abfd) != count)
244 return FALSE;
245 return TRUE;
249 /* Return the amount of memory needed to read the symbol table. */
251 static long
252 ppcboot_get_symtab_upper_bound (abfd)
253 bfd *abfd ATTRIBUTE_UNUSED;
255 return (PPCBOOT_SYMS + 1) * sizeof (asymbol *);
259 /* Create a symbol name based on the bfd's filename. */
261 static char *
262 mangle_name (abfd, suffix)
263 bfd *abfd;
264 char *suffix;
266 bfd_size_type size;
267 char *buf;
268 char *p;
270 size = (strlen (bfd_get_filename (abfd))
271 + strlen (suffix)
272 + sizeof "_ppcboot__");
274 buf = (char *) bfd_alloc (abfd, size);
275 if (buf == NULL)
276 return "";
278 sprintf (buf, "_ppcboot_%s_%s", bfd_get_filename (abfd), suffix);
280 /* Change any non-alphanumeric characters to underscores. */
281 for (p = buf; *p; p++)
282 if (! ISALNUM (*p))
283 *p = '_';
285 return buf;
289 /* Return the symbol table. */
291 static long
292 ppcboot_canonicalize_symtab (abfd, alocation)
293 bfd *abfd;
294 asymbol **alocation;
296 asection *sec = ppcboot_get_tdata (abfd)->sec;
297 asymbol *syms;
298 unsigned int i;
299 bfd_size_type amt = PPCBOOT_SYMS * sizeof (asymbol);
301 syms = (asymbol *) bfd_alloc (abfd, amt);
302 if (syms == NULL)
303 return FALSE;
305 /* Start symbol. */
306 syms[0].the_bfd = abfd;
307 syms[0].name = mangle_name (abfd, "start");
308 syms[0].value = 0;
309 syms[0].flags = BSF_GLOBAL;
310 syms[0].section = sec;
311 syms[0].udata.p = NULL;
313 /* End symbol. */
314 syms[1].the_bfd = abfd;
315 syms[1].name = mangle_name (abfd, "end");
316 syms[1].value = sec->size;
317 syms[1].flags = BSF_GLOBAL;
318 syms[1].section = sec;
319 syms[1].udata.p = NULL;
321 /* Size symbol. */
322 syms[2].the_bfd = abfd;
323 syms[2].name = mangle_name (abfd, "size");
324 syms[2].value = sec->size;
325 syms[2].flags = BSF_GLOBAL;
326 syms[2].section = bfd_abs_section_ptr;
327 syms[2].udata.p = NULL;
329 for (i = 0; i < PPCBOOT_SYMS; i++)
330 *alocation++ = syms++;
331 *alocation = NULL;
333 return PPCBOOT_SYMS;
336 #define ppcboot_make_empty_symbol _bfd_generic_make_empty_symbol
337 #define ppcboot_print_symbol _bfd_nosymbols_print_symbol
339 /* Get information about a symbol. */
341 static void
342 ppcboot_get_symbol_info (ignore_abfd, symbol, ret)
343 bfd *ignore_abfd ATTRIBUTE_UNUSED;
344 asymbol *symbol;
345 symbol_info *ret;
347 bfd_symbol_info (symbol, ret);
350 #define ppcboot_bfd_is_target_special_symbol \
351 ((bfd_boolean (*) (bfd *, asymbol *)) bfd_false)
352 #define ppcboot_bfd_is_local_label_name bfd_generic_is_local_label_name
353 #define ppcboot_get_lineno _bfd_nosymbols_get_lineno
354 #define ppcboot_find_nearest_line _bfd_nosymbols_find_nearest_line
355 #define ppcboot_find_inliner_info _bfd_nosymbols_find_inliner_info
356 #define ppcboot_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
357 #define ppcboot_read_minisymbols _bfd_generic_read_minisymbols
358 #define ppcboot_minisymbol_to_symbol _bfd_generic_minisymbol_to_symbol
360 /* Write section contents of a ppcboot file. */
362 static bfd_boolean
363 ppcboot_set_section_contents (abfd, sec, data, offset, size)
364 bfd *abfd;
365 asection *sec;
366 const PTR data;
367 file_ptr offset;
368 bfd_size_type size;
370 if (! abfd->output_has_begun)
372 bfd_vma low;
373 asection *s;
375 /* The lowest section VMA sets the virtual address of the start
376 of the file. We use the set the file position of all the
377 sections. */
378 low = abfd->sections->vma;
379 for (s = abfd->sections->next; s != NULL; s = s->next)
380 if (s->vma < low)
381 low = s->vma;
383 for (s = abfd->sections; s != NULL; s = s->next)
384 s->filepos = s->vma - low;
386 abfd->output_has_begun = TRUE;
389 return _bfd_generic_set_section_contents (abfd, sec, data, offset, size);
393 static int
394 ppcboot_sizeof_headers (bfd *abfd ATTRIBUTE_UNUSED,
395 struct bfd_link_info *info ATTRIBUTE_UNUSED)
397 return sizeof (ppcboot_hdr_t);
401 /* Print out the program headers. */
403 static bfd_boolean
404 ppcboot_bfd_print_private_bfd_data (abfd, farg)
405 bfd *abfd;
406 PTR farg;
408 FILE *f = (FILE *)farg;
409 ppcboot_data_t *tdata = ppcboot_get_tdata (abfd);
410 long entry_offset = bfd_getl_signed_32 ((PTR) tdata->header.entry_offset);
411 long length = bfd_getl_signed_32 ((PTR) tdata->header.length);
412 int i;
414 fprintf (f, _("\nppcboot header:\n"));
415 fprintf (f, _("Entry offset = 0x%.8lx (%ld)\n"), entry_offset, entry_offset);
416 fprintf (f, _("Length = 0x%.8lx (%ld)\n"), length, length);
418 if (tdata->header.flags)
419 fprintf (f, _("Flag field = 0x%.2x\n"), tdata->header.flags);
421 if (tdata->header.os_id)
422 fprintf (f, "OS_ID = 0x%.2x\n", tdata->header.os_id);
424 if (tdata->header.partition_name)
425 fprintf (f, _("Partition name = \"%s\"\n"), tdata->header.partition_name);
427 for (i = 0; i < 4; i++)
429 long sector_begin = bfd_getl_signed_32 ((PTR) tdata->header.partition[i].sector_begin);
430 long sector_length = bfd_getl_signed_32 ((PTR) tdata->header.partition[i].sector_length);
432 /* Skip all 0 entries */
433 if (!tdata->header.partition[i].partition_begin.ind
434 && !tdata->header.partition[i].partition_begin.head
435 && !tdata->header.partition[i].partition_begin.sector
436 && !tdata->header.partition[i].partition_begin.cylinder
437 && !tdata->header.partition[i].partition_end.ind
438 && !tdata->header.partition[i].partition_end.head
439 && !tdata->header.partition[i].partition_end.sector
440 && !tdata->header.partition[i].partition_end.cylinder
441 && !sector_begin && !sector_length)
442 continue;
444 fprintf (f, _("\nPartition[%d] start = { 0x%.2x, 0x%.2x, 0x%.2x, 0x%.2x }\n"), i,
445 tdata->header.partition[i].partition_begin.ind,
446 tdata->header.partition[i].partition_begin.head,
447 tdata->header.partition[i].partition_begin.sector,
448 tdata->header.partition[i].partition_begin.cylinder);
450 fprintf (f, _("Partition[%d] end = { 0x%.2x, 0x%.2x, 0x%.2x, 0x%.2x }\n"), i,
451 tdata->header.partition[i].partition_end.ind,
452 tdata->header.partition[i].partition_end.head,
453 tdata->header.partition[i].partition_end.sector,
454 tdata->header.partition[i].partition_end.cylinder);
456 fprintf (f, _("Partition[%d] sector = 0x%.8lx (%ld)\n"), i, sector_begin, sector_begin);
457 fprintf (f, _("Partition[%d] length = 0x%.8lx (%ld)\n"), i, sector_length, sector_length);
460 fprintf (f, "\n");
461 return TRUE;
465 #define ppcboot_bfd_get_relocated_section_contents \
466 bfd_generic_get_relocated_section_contents
467 #define ppcboot_bfd_relax_section bfd_generic_relax_section
468 #define ppcboot_bfd_gc_sections bfd_generic_gc_sections
469 #define ppcboot_bfd_merge_sections bfd_generic_merge_sections
470 #define ppcboot_bfd_is_group_section bfd_generic_is_group_section
471 #define ppcboot_bfd_discard_group bfd_generic_discard_group
472 #define ppcboot_section_already_linked \
473 _bfd_generic_section_already_linked
474 #define ppcboot_bfd_link_hash_table_create _bfd_generic_link_hash_table_create
475 #define ppcboot_bfd_link_hash_table_free _bfd_generic_link_hash_table_free
476 #define ppcboot_bfd_link_add_symbols _bfd_generic_link_add_symbols
477 #define ppcboot_bfd_link_just_syms _bfd_generic_link_just_syms
478 #define ppcboot_bfd_final_link _bfd_generic_final_link
479 #define ppcboot_bfd_link_split_section _bfd_generic_link_split_section
480 #define ppcboot_get_section_contents_in_window \
481 _bfd_generic_get_section_contents_in_window
483 #define ppcboot_bfd_copy_private_bfd_data _bfd_generic_bfd_copy_private_bfd_data
484 #define ppcboot_bfd_merge_private_bfd_data _bfd_generic_bfd_merge_private_bfd_data
485 #define ppcboot_bfd_copy_private_section_data _bfd_generic_bfd_copy_private_section_data
486 #define ppcboot_bfd_copy_private_symbol_data _bfd_generic_bfd_copy_private_symbol_data
487 #define ppcboot_bfd_copy_private_header_data _bfd_generic_bfd_copy_private_header_data
488 #define ppcboot_bfd_set_private_flags _bfd_generic_bfd_set_private_flags
489 #define ppcboot_bfd_print_private_bfd_dat ppcboot_bfd_print_private_bfd_data
491 const bfd_target ppcboot_vec =
493 "ppcboot", /* name */
494 bfd_target_unknown_flavour, /* flavour */
495 BFD_ENDIAN_BIG, /* byteorder is big endian for code */
496 BFD_ENDIAN_LITTLE, /* header_byteorder */
497 EXEC_P, /* object_flags */
498 (SEC_ALLOC | SEC_LOAD | SEC_READONLY | SEC_CODE | SEC_DATA
499 | SEC_ROM | SEC_HAS_CONTENTS), /* section_flags */
500 0, /* symbol_leading_char */
501 ' ', /* ar_pad_char */
502 16, /* ar_max_namelen */
503 bfd_getb64, bfd_getb_signed_64, bfd_putb64,
504 bfd_getb32, bfd_getb_signed_32, bfd_putb32,
505 bfd_getb16, bfd_getb_signed_16, bfd_putb16, /* data */
506 bfd_getl64, bfd_getl_signed_64, bfd_putl64,
507 bfd_getl32, bfd_getl_signed_32, bfd_putl32,
508 bfd_getl16, bfd_getl_signed_16, bfd_putl16, /* hdrs */
509 { /* bfd_check_format */
510 _bfd_dummy_target,
511 ppcboot_object_p, /* bfd_check_format */
512 _bfd_dummy_target,
513 _bfd_dummy_target,
515 { /* bfd_set_format */
516 bfd_false,
517 ppcboot_mkobject,
518 bfd_false,
519 bfd_false,
521 { /* bfd_write_contents */
522 bfd_false,
523 bfd_true,
524 bfd_false,
525 bfd_false,
528 BFD_JUMP_TABLE_GENERIC (ppcboot),
529 BFD_JUMP_TABLE_COPY (ppcboot),
530 BFD_JUMP_TABLE_CORE (_bfd_nocore),
531 BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive),
532 BFD_JUMP_TABLE_SYMBOLS (ppcboot),
533 BFD_JUMP_TABLE_RELOCS (_bfd_norelocs),
534 BFD_JUMP_TABLE_WRITE (ppcboot),
535 BFD_JUMP_TABLE_LINK (ppcboot),
536 BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic),
538 NULL,
540 NULL