1 /* This file is part of the program psim.
3 Copyright (C) 1994-1998, Andrew Cagney <cagney@highland.com.au>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 #include "sim-assert.h"
42 /* manipulate/lookup device names */
44 typedef struct _name_specifier {
46 /* components in the full length name */
70 /* Given a device specifier, break it up into its main components:
71 path (and if present) property name and property value. */
74 split_device_specifier (struct hw *current,
75 const char *device_specifier,
80 /* expand any leading alias if present */
82 && *device_specifier != '\0'
83 && *device_specifier != '.'
84 && *device_specifier != '/')
86 struct hw *aliases = hw_tree_find_device (current, "/aliases");
89 while (device_specifier[len] != '\0'
90 && device_specifier[len] != '/'
91 && device_specifier[len] != ':'
92 && !isspace (device_specifier[len]))
94 alias[len] = device_specifier[len];
96 if (len >= sizeof(alias))
97 hw_abort (NULL, "split_device_specifier: buffer overflow");
101 && hw_find_property (aliases, alias))
103 strcpy (spec->buf, hw_find_string_property(aliases, alias));
104 strcat (spec->buf, device_specifier + len);
108 strcpy (spec->buf, device_specifier);
113 strcpy(spec->buf, device_specifier);
116 /* check no overflow */
117 if (strlen(spec->buf) >= sizeof(spec->buf))
118 hw_abort (NULL, "split_device_specifier: buffer overflow\n");
120 /* strip leading spaces */
122 while (*chp != '\0' && isspace(*chp))
127 /* find the path and terminate it with null */
129 while (*chp != '\0' && !isspace(*chp))
138 while (*chp != '\0' && isspace(*chp))
142 /* now go back and chop the property off of the path */
143 if (spec->value[0] == '\0')
145 spec->property = NULL; /*not a property*/
148 else if (spec->value[0] == '>'
149 || spec->value[0] == '<')
151 /* an interrupt spec */
152 spec->property = NULL;
155 chp = strrchr(spec->path, '/');
158 spec->property = spec->path;
159 spec->path = strchr(spec->property, '\0');
163 spec->property = chp+1;
167 /* and mark the rest as invalid */
172 spec->last_name = NULL;
173 spec->last_family = NULL;
174 spec->last_unit = NULL;
175 spec->last_args = NULL;
181 /* given a device specifier break it up into its main components -
182 path and property name - assuming that the last `device' is a
186 split_property_specifier (struct hw *current,
187 const char *property_specifier,
188 name_specifier *spec)
190 if (split_device_specifier (current, property_specifier, spec))
192 if (spec->property == NULL)
194 /* force the last name to be a property name */
195 char *chp = strrchr (spec->path, '/');
198 spec->property = spec->path;
199 spec->path = strrchr (spec->property, '\0');;
204 spec->property = chp + 1;
214 /* device the next device name and split it up, return 0 when no more
215 names to struct hw */
218 split_device_name (name_specifier *spec)
221 /* remember what came before */
222 spec->last_name = spec->name;
223 spec->last_family = spec->family;
224 spec->last_unit = spec->unit;
225 spec->last_args = spec->args;
227 if (spec->path[0] == '\0')
235 /* break the current device spec from the path */
236 spec->name = spec->path;
237 chp = strchr (spec->name, '/');
239 spec->path = strchr (spec->name, '\0');
245 /* break out the base */
246 if (spec->name[0] == '(')
248 chp = strchr(spec->name, ')');
251 spec->family = spec->name;
256 spec->family = spec->name + 1;
257 spec->name = chp + 1;
262 spec->family = spec->name;
264 /* now break out the unit */
265 chp = strchr(spec->name, '@');
277 /* finally any args */
278 chp = strchr(chp, ':');
290 /* device the value, returning the next non-space token */
293 split_value (name_specifier *spec)
296 if (spec->value == NULL)
298 /* skip leading white space */
299 while (isspace (spec->value[0]))
301 if (spec->value[0] == '\0')
307 /* find trailing space */
308 while (spec->value[0] != '\0' && !isspace (spec->value[0]))
310 /* chop this value out */
311 if (spec->value[0] != '\0')
313 spec->value[0] = '\0';
321 /* traverse the path specified by spec starting at current */
324 split_find_device (struct hw *current,
325 name_specifier *spec)
327 /* strip off (and process) any leading ., .., ./ and / */
330 if (strncmp (spec->path, "/", strlen ("/")) == 0)
333 while (current != NULL && hw_parent (current) != NULL)
334 current = hw_parent (current);
335 spec->path += strlen ("/");
337 else if (strncmp (spec->path, "./", strlen ("./")) == 0)
341 spec->path += strlen ("./");
343 else if (strncmp (spec->path, "../", strlen ("../")) == 0)
346 if (current != NULL && hw_parent (current) != NULL)
347 current = hw_parent (current);
348 spec->path += strlen ("../");
350 else if (strcmp (spec->path, ".") == 0)
354 spec->path += strlen (".");
356 else if (strcmp (spec->path, "..") == 0)
359 if (current != NULL && hw_parent (current) != NULL)
360 current = hw_parent (current);
361 spec->path += strlen ("..");
367 /* now go through the path proper */
371 split_device_name (spec);
375 while (split_device_name (spec))
378 for (child = hw_child (current);
379 child != NULL; child = hw_sibling (child))
381 if (strcmp (spec->name, hw_name (child)) == 0)
383 if (spec->unit == NULL)
388 hw_unit_decode (current, spec->unit, &phys);
389 if (memcmp (&phys, hw_unit_address (child),
390 sizeof (hw_unit)) == 0)
396 return current; /* search failed */
405 split_fill_path (struct hw *current,
406 const char *device_specifier,
407 name_specifier *spec)
410 if (!split_device_specifier (current, device_specifier, spec))
411 hw_abort (current, "error parsing %s\n", device_specifier);
413 /* fill our tree with its contents */
414 current = split_find_device (current, spec);
416 /* add any additional devices as needed */
417 if (spec->name != NULL)
421 if (current != NULL && !hw_finished_p (current))
423 current = hw_create (NULL,
430 while (split_device_name (spec));
437 /* <non-white-space> */
440 skip_token(const char *chp)
442 while (!isspace(*chp) && *chp != '\0')
444 while (isspace(*chp) && *chp != '\0')
450 /* count the number of entries */
453 count_entries (struct hw *current,
454 const char *property_name,
455 const char *property_value,
458 const char *chp = property_value;
463 chp = skip_token (chp);
465 if ((nr_entries % modulo) != 0)
467 hw_abort (current, "incorrect number of entries for %s property %s, should be multiple of %d",
468 property_name, property_value, modulo);
470 return nr_entries / modulo;
475 /* parse: <address> ::= <token> ; device dependant */
478 parse_address (struct hw *current,
483 if (hw_unit_decode (bus, chp, address) < 0)
484 hw_abort (current, "invalid unit address in %s", chp);
485 return skip_token (chp);
489 /* parse: <size> ::= <number> { "," <number> } ; */
492 parse_size (struct hw *current,
499 const char *curr = chp;
500 memset(size, 0, sizeof(*size));
501 /* parse the numeric list */
502 size->nr_cells = hw_unit_nr_size_cells (bus);
507 size->cells[nr] = strtoul (curr, &next, 0);
509 hw_abort (current, "Problem parsing <size> %s", chp);
513 if (nr == size->nr_cells)
514 hw_abort (current, "Too many values in <size> %s", chp);
517 ASSERT (nr > 0 && nr <= size->nr_cells);
518 /* right align the numbers */
519 for (i = 1; i <= size->nr_cells; i++)
522 size->cells[size->nr_cells - i] = size->cells[nr - i];
524 size->cells[size->nr_cells - i] = 0;
526 return skip_token (chp);
530 /* parse: <reg> ::= { <address> <size> } ; */
533 parse_reg_property (struct hw *current,
534 const char *property_name,
535 const char *property_value)
539 reg_property_spec *regs;
542 /* determine the number of reg entries by counting tokens */
543 nr_regs = count_entries (current, property_name, property_value, 2);
545 /* create working space */
546 regs = zalloc (nr_regs * sizeof (*regs));
549 chp = property_value;
550 for (reg_nr = 0; reg_nr < nr_regs; reg_nr++)
552 chp = parse_address (current, hw_parent(current),
553 chp, ®s[reg_nr].address);
554 chp = parse_size (current, hw_parent(current),
555 chp, ®s[reg_nr].size);
559 hw_add_reg_array_property (current, property_name,
566 /* { <child-address> <parent-address> <child-size> }* */
569 parse_ranges_property (struct hw *current,
570 const char *property_name,
571 const char *property_value)
575 range_property_spec *ranges;
578 /* determine the number of ranges specified */
579 nr_ranges = count_entries (current, property_name, property_value, 3);
581 /* create a property of that size */
582 ranges = zalloc (nr_ranges * sizeof(*ranges));
585 chp = property_value;
586 for (range_nr = 0; range_nr < nr_ranges; range_nr++)
588 chp = parse_address (current, current,
589 chp, &ranges[range_nr].child_address);
590 chp = parse_address (current, hw_parent(current),
591 chp, &ranges[range_nr].parent_address);
592 chp = parse_size (current, current,
593 chp, &ranges[range_nr].size);
597 hw_add_range_array_property (current, property_name, ranges, nr_ranges);
606 parse_integer_property (struct hw *current,
607 const char *property_name,
608 const char *property_value)
611 unsigned_cell words[1024];
612 /* integer or integer array? */
617 words[nr_entries] = strtoul (property_value, &end, 0);
618 if (property_value == end)
621 if (nr_entries * sizeof (words[0]) >= sizeof (words))
622 hw_abort (current, "buffer overflow");
623 property_value = end;
626 hw_abort (current, "error parsing integer property %s (%s)",
627 property_name, property_value);
628 else if (nr_entries == 1)
629 hw_add_integer_property (current, property_name, words[0]);
633 for (i = 0; i < nr_entries; i++)
637 /* perhaphs integer array property is better */
638 hw_add_array_property (current, property_name, words,
639 sizeof(words[0]) * nr_entries);
647 parse_string_property (struct hw *current,
648 const char *property_name,
649 const char *property_value)
654 int approx_nr_strings;
656 /* get an estimate as to the number of strings by counting double
658 approx_nr_strings = 2;
659 for (chp = property_value; *chp; chp++)
664 approx_nr_strings = (approx_nr_strings) / 2;
666 /* create a string buffer for that many (plus a null) */
667 strings = (char**) zalloc ((approx_nr_strings + 1) * sizeof(char*));
669 /* now find all the strings */
670 chp = property_value;
675 /* skip leading space */
676 while (*chp != '\0' && isspace (*chp))
684 /* a quoted string - watch for '\' et.al. */
685 /* estimate the size and allocate space for it */
689 while (chp[pos] != '\0' && chp[pos] != '"')
691 if (chp[pos] == '\\' && chp[pos+1] != '\0')
696 strings[nr_strings] = zalloc (pos + 1);
697 /* copy the string over */
699 while (*chp != '\0' && *chp != '"')
701 if (*chp == '\\' && *(chp+1) != '\0') {
702 strings[nr_strings][pos] = *(chp+1);
708 strings[nr_strings][pos] = *chp;
715 strings[nr_strings][pos] = '\0';
719 /* copy over a single unquoted token */
721 while (chp[len] != '\0' && !isspace(chp[len]))
723 strings[nr_strings] = zalloc(len + 1);
724 strncpy(strings[nr_strings], chp, len);
725 strings[nr_strings][len] = '\0';
729 if (nr_strings > approx_nr_strings)
730 hw_abort (current, "String property %s badly formatted",
733 ASSERT (strings[nr_strings] == NULL); /* from zalloc */
737 hw_add_string_property (current, property_name, "");
738 else if (nr_strings == 1)
739 hw_add_string_property (current, property_name, strings[0]);
742 const char **specs = (const char**) strings; /* stop a bogus error */
743 hw_add_string_array_property (current, property_name,
747 /* flush the created string */
748 while (nr_strings > 0)
751 zfree (strings[nr_strings]);
757 /* <path-to-ihandle-device> */
761 parse_ihandle_property (struct hw *current,
762 const char *property,
765 ihandle_runtime_property_spec ihandle;
767 /* pass the full path */
768 ihandle.full_path = value;
770 /* save this ready for the ihandle create */
771 hw_add_ihandle_runtime_property (current, property,
778 hw_tree_create (SIM_DESC sd,
781 return hw_create (sd, NULL, family, family, NULL, NULL);
785 hw_tree_delete (struct hw *me)
787 /* Need to allow devices to disapear under our feet */
788 while (hw_child (me) != NULL)
790 hw_tree_delete (hw_child (me));
797 hw_tree_parse (struct hw *current,
803 current = hw_tree_vparse (current, fmt, ap);
809 hw_tree_vparse (struct hw *current,
813 char device_specifier[1024];
816 /* format the path */
817 vsprintf (device_specifier, fmt, ap);
818 if (strlen (device_specifier) >= sizeof (device_specifier))
819 hw_abort (NULL, "device_tree_add_deviced: buffer overflow\n");
821 /* construct the tree down to the final struct hw */
822 current = split_fill_path (current, device_specifier, &spec);
824 /* is there an interrupt spec */
825 if (spec.property == NULL
826 && spec.value != NULL)
828 char *op = split_value (&spec);
833 char *my_port_name = split_value (&spec);
835 char *dest_port_name = split_value (&spec);
837 name_specifier dest_spec;
838 char *dest_hw_name = split_value (&spec);
841 if (!hw_finished_p (current))
843 my_port = hw_port_decode (current, my_port_name, output_port);
844 /* find the dest device and port */
845 dest = split_fill_path (current, dest_hw_name, &dest_spec);
846 if (!hw_finished_p (dest))
848 dest_port = hw_port_decode (dest, dest_port_name,
850 /* connect the two */
851 hw_port_attach (current,
859 hw_abort (current, "unreconised interrupt spec %s\n", spec.value);
864 /* is there a property */
865 if (spec.property != NULL)
867 if (strcmp (spec.value, "true") == 0)
868 hw_add_boolean_property (current, spec.property, 1);
869 else if (strcmp (spec.value, "false") == 0)
870 hw_add_boolean_property (current, spec.property, 0);
873 const struct hw_property *property;
874 switch (spec.value[0])
879 parse_ihandle_property (current, spec.property, spec.value + 1);
885 unsigned8 words[1024];
886 char *curr = spec.value + 1;
891 words[nr_words] = H2BE_1 (strtoul (curr, &next, 0));
897 hw_add_array_property (current, spec.property,
898 words, sizeof(words[0]) * nr_words);
903 parse_string_property (current, spec.property, spec.value);
909 property = hw_tree_find_property (current, spec.value);
910 if (property == NULL)
911 hw_abort (current, "property %s not found\n", spec.value);
912 hw_add_duplicate_property (current,
919 if (strcmp (spec.property, "reg") == 0
920 || strcmp (spec.property, "assigned-addresses") == 0
921 || strcmp (spec.property, "alternate-reg") == 0)
923 parse_reg_property (current, spec.property, spec.value);
925 else if (strcmp (spec.property, "ranges") == 0)
927 parse_ranges_property (current, spec.property, spec.value);
929 else if (isdigit(spec.value[0])
930 || (spec.value[0] == '-' && isdigit(spec.value[1]))
931 || (spec.value[0] == '+' && isdigit(spec.value[1])))
933 parse_integer_property(current, spec.property, spec.value);
936 parse_string_property(current, spec.property, spec.value);
947 finish_hw_tree (struct hw *me,
950 if (!hw_finished_p (me))
955 hw_tree_finish (struct hw *root)
957 hw_tree_traverse (root, finish_hw_tree, NULL, NULL);
963 hw_tree_traverse (struct hw *root,
964 hw_tree_traverse_function *prefix,
965 hw_tree_traverse_function *postfix,
971 for (child = hw_child (root);
973 child = hw_sibling (child))
975 hw_tree_traverse (child, prefix, postfix, data);
978 postfix (root, data);
984 hw_tree_print_callback *print;
989 print_address (struct hw *bus,
994 hw_unit_encode (bus, phys, unit, sizeof(unit));
995 p->print (p->file, " %s", unit);
999 print_size (struct hw *bus,
1000 const hw_unit *size,
1004 for (i = 0; i < size->nr_cells; i++)
1005 if (size->cells[i] != 0)
1007 if (i < size->nr_cells) {
1008 p->print (p->file, " 0x%lx", (unsigned long) size->cells[i]);
1010 for (; i < size->nr_cells; i++)
1011 p->print (p->file, ",0x%lx", (unsigned long) size->cells[i]);
1014 p->print (p->file, " 0");
1018 print_reg_property (struct hw *me,
1019 const struct hw_property *property,
1023 reg_property_spec reg;
1025 hw_find_reg_array_property (me, property->name, reg_nr, ®);
1027 print_address (hw_parent (me), ®.address, p);
1028 print_size (me, ®.size, p);
1033 print_ranges_property (struct hw *me,
1034 const struct hw_property *property,
1038 range_property_spec range;
1040 hw_find_range_array_property (me, property->name, range_nr, &range);
1043 print_address (me, &range.child_address, p);
1044 print_address (hw_parent (me), &range.parent_address, p);
1045 print_size (me, &range.size, p);
1050 print_string (struct hw *me,
1054 p->print (p->file, " \"");
1055 while (*string != '\0') {
1058 p->print (p->file, "\\\"");
1061 p->print (p->file, "\\\\");
1064 p->print (p->file, "%c", *string);
1069 p->print (p->file, "\"");
1073 print_string_array_property (struct hw *me,
1074 const struct hw_property *property,
1078 string_property_spec string;
1080 hw_find_string_array_property (me, property->name, nr, &string);
1083 print_string (me, string, p);
1088 print_properties (struct hw *me,
1091 const struct hw_property *property;
1092 for (property = hw_find_property (me, NULL);
1094 property = hw_next_property (property))
1096 if (hw_parent (me) == NULL)
1097 p->print (p->file, "/%s", property->name);
1099 p->print (p->file, "%s/%s", hw_path (me), property->name);
1100 if (property->original != NULL)
1102 p->print (p->file, " !");
1103 p->print (p->file, "%s/%s",
1104 hw_path (property->original->owner),
1105 property->original->name);
1109 switch (property->type)
1111 case array_property:
1113 if ((property->sizeof_array % sizeof (signed_cell)) == 0)
1115 unsigned_cell *w = (unsigned_cell*) property->array;
1118 cell_nr < (property->sizeof_array / sizeof (unsigned_cell));
1121 p->print (p->file, " 0x%lx", (unsigned long) BE2H_cell (w[cell_nr]));
1126 unsigned8 *w = (unsigned8*)property->array;
1127 p->print (p->file, " [");
1128 while ((char*)w - (char*)property->array < property->sizeof_array) {
1129 p->print (p->file, " 0x%2x", BE2H_1 (*w));
1135 case boolean_property:
1137 int b = hw_find_boolean_property(me, property->name);
1138 p->print (p->file, " %s", b ? "true" : "false");
1142 case ihandle_property:
1144 if (property->array != NULL)
1146 device_instance *instance = hw_find_ihandle_property (me, property->name);
1147 p->print (p->file, " *%s", device_instance_path(instance));
1151 /* not yet initialized, ask the device for the path */
1152 ihandle_runtime_property_spec spec;
1153 hw_find_ihandle_runtime_property (me, property->name, &spec);
1154 p->print (p->file, " *%s", spec.full_path);
1159 case integer_property:
1161 unsigned_word w = hw_find_integer_property (me, property->name);
1162 p->print (p->file, " 0x%lx", (unsigned long)w);
1165 case range_array_property:
1167 print_ranges_property (me, property, p);
1170 case reg_array_property:
1172 print_reg_property (me, property, p);
1175 case string_property:
1177 const char *s = hw_find_string_property (me, property->name);
1178 print_string (me, s, p);
1181 case string_array_property:
1183 print_string_array_property (me, property, p);
1188 p->print (p->file, "\n");
1193 print_interrupts (struct hw *me,
1199 struct printer *p = data;
1202 hw_port_encode (me, my_port, src, sizeof(src), output_port);
1203 hw_port_encode (dest, dest_port, dst, sizeof(dst), input_port);
1212 print_device (struct hw *me,
1215 struct printer *p = data;
1216 p->print (p->file, "%s\n", hw_path (me));
1217 print_properties (me, p);
1218 hw_port_traverse (me, print_interrupts, data);
1222 hw_tree_print (struct hw *root,
1223 hw_tree_print_callback *print,
1229 hw_tree_traverse (root,
1238 tree_instance(struct hw *root,
1239 const char *device_specifier)
1241 /* find the device node */
1243 name_specifier spec;
1244 if (!split_device_specifier(root, device_specifier, &spec))
1246 me = split_find_device(root, &spec);
1247 if (spec.name != NULL)
1249 /* create the instance */
1250 return device_create_instance(me, device_specifier, spec.last_args);
1255 hw_tree_find_device (struct hw *root,
1256 const char *path_to_device)
1259 name_specifier spec;
1261 /* parse the path */
1262 split_device_specifier (root, path_to_device, &spec);
1263 if (spec.value != NULL)
1264 return NULL; /* something wierd */
1267 node = split_find_device (root, &spec);
1268 if (spec.name != NULL)
1269 return NULL; /* not a leaf */
1275 const struct hw_property *
1276 hw_tree_find_property (struct hw *root,
1277 const char *path_to_property)
1279 name_specifier spec;
1280 if (!split_property_specifier (root, path_to_property, &spec))
1281 hw_abort (root, "Invalid property path %s", path_to_property);
1282 root = split_find_device (root, &spec);
1283 if (spec.name != NULL)
1284 return NULL; /* not a leaf */
1285 return hw_find_property (root, spec.property);
1289 hw_tree_find_boolean_property (struct hw *root,
1290 const char *path_to_property)
1292 name_specifier spec;
1293 if (!split_property_specifier (root, path_to_property, &spec))
1294 hw_abort (root, "Invalid property path %s", path_to_property);
1295 root = split_find_device (root, &spec);
1296 if (spec.name != NULL)
1297 hw_abort (root, "device \"%s\" not found (property \"%s\")",
1298 spec.name, path_to_property);
1299 return hw_find_boolean_property (root, spec.property);
1303 hw_tree_find_integer_property (struct hw *root,
1304 const char *path_to_property)
1306 name_specifier spec;
1307 if (!split_property_specifier (root, path_to_property, &spec))
1308 hw_abort (root, "Invalid property path %s", path_to_property);
1309 root = split_find_device (root, &spec);
1310 if (spec.name != NULL)
1311 hw_abort (root, "device \"%s\" not found (property \"%s\")",
1312 spec.name, path_to_property);
1313 return hw_find_integer_property (root, spec.property);
1318 hw_tree_find_ihandle_property (struct hw *root,
1319 const char *path_to_property)
1322 name_specifier spec;
1323 if (!split_property_specifier (root, path_to_property, &spec))
1324 hw_abort (root, "Invalid property path %s", path_to_property);
1325 root = split_find_device (root, &spec);
1326 if (spec.name != NULL)
1327 hw_abort (root, "device \"%s\" not found (property \"%s\")",
1328 spec.name, path_to_property);
1329 return hw_find_ihandle_property (root, spec.property);
1334 hw_tree_find_string_property (struct hw *root,
1335 const char *path_to_property)
1337 name_specifier spec;
1338 if (!split_property_specifier (root, path_to_property, &spec))
1339 hw_abort (root, "Invalid property path %s", path_to_property);
1340 root = split_find_device (root, &spec);
1341 if (spec.name != NULL)
1342 hw_abort (root, "device \"%s\" not found (property \"%s\")",
1343 spec.name, path_to_property);
1344 return hw_find_string_property (root, spec.property);