3 * - By John Hodge (thePowersGang)
6 * - UDI Entrypoint and Module loading
9 #define VERSION ((0<<8)|1)
13 #include <udi_internal.h>
14 #include <udi_internal_ma.h>
15 #include <trans_pci.h>
16 #include <trans_nsr.h>
17 #include <trans_uart.h>
20 int UDI_Install(char **Arguments);
21 int UDI_DetectDriver(void *Base);
22 int UDI_LoadDriver(void *Base);
23 tUDI_DriverModule *UDI_int_LoadDriver(void *LoadBase, const udi_init_t *info, const char *udiprops, size_t udiprops_size);
24 const tUDI_MetaLang *UDI_int_GetMetaLangByName(const char *Name);
27 MODULE_DEFINE(0, VERSION, UDI, UDI_Install, NULL, NULL);
28 tModuleLoader gUDI_Loader = {
29 NULL, "UDI", UDI_DetectDriver, UDI_LoadDriver, NULL
31 tUDI_DriverModule *gpUDI_LoadedModules;
35 * \fn int UDI_Install(char **Arguments)
36 * \brief Stub intialisation routine
38 int UDI_Install(char **Arguments)
40 Module_RegisterLoader( &gUDI_Loader );
42 Proc_SpawnWorker(UDI_int_DeferredThread, NULL);
44 UDI_int_LoadDriver(NULL, &pci_init, pci_udiprops, pci_udiprops_size);
45 UDI_int_LoadDriver(NULL, &acessnsr_init, acessnsr_udiprops, acessnsr_udiprops_size);
46 UDI_int_LoadDriver(NULL, &acessuart_init, acessuart_udiprops, acessuart_udiprops_size);
52 * \brief Detects if a driver should be loaded by the UDI subsystem
54 int UDI_DetectDriver(void *Base)
58 if( Binary_FindSymbol(Base, "udi_init_info", &unused) == 0) {
61 if( Binary_FindSymbol(Base, "_udiprops", &unused) == 0 ) {
62 Log_Warning("UDI", "Driver has udi_init_info, but no _udiprops symbol");
65 if( Binary_FindSymbol(Base, "_udiprops_end", &unused) == 0) {
66 Log_Warning("UDI", "Driver has udi_init_info, but no _udiprops_end symbol");
74 * \fn int UDI_LoadDriver(void *Base)
76 int UDI_LoadDriver(void *Base)
79 char *udiprops = NULL;
80 char *udiprops_end = 0;
82 if( Binary_FindSymbol(Base, "udi_init_info", (Uint*)&info) == 0) {
87 Binary_FindSymbol(Base, "_udiprops", (Uint*)&udiprops);
88 Binary_FindSymbol(Base, "_udiprops_end", (Uint*)&udiprops_end);
89 Log_Debug("UDI", "udiprops = %p, udiprops_end = %p", udiprops, udiprops_end);
91 UDI_int_LoadDriver(Base, info, udiprops, udiprops_end - udiprops);
96 static udi_boolean_t _get_token_bool(const char *str, const char **outstr)
113 while( isspace(*str) )
118 static udi_index_t _get_token_idx(const char *str, const char **outstr)
121 int ret = strtol(str, &end, 10);
122 if( ret < 0 || ret > 255 ) {
123 Log_Notice("UDI", "Value '%.*s' out of range for udi_index_t",
128 if( *end && !isspace(*end) ) {
129 Log_Notice("UDI", "No whitespace following '%.*s', got '%c'",
134 while( *end && isspace(*end) )
140 static udi_ubit16_t _get_token_uint16(const char *str, const char **outstr)
143 unsigned long ret = strtoul(str, &end, 10);
145 Log_Notice("UDI", "Value '%.*s' out of range for udi_ubit16_t",
150 if( *end && !isspace(*end) ) {
151 Log_Notice("UDI", "No whitespace following '%.*s', got '%c'",
156 while( *end && isspace(*end) )
162 static udi_ubit32_t _get_token_uint32(const char *str, const char **outstr)
165 udi_ubit32_t ret = strtoul(str, &end, 0);
166 if( *end && !isspace(*end) ) {
167 Log_Notice("UDI", "No whitespace following '%.*s', got '%c'",
172 while( *end && isspace(*end) )
178 static size_t _get_token_str(const char *str, const char **outstr, char *output)
181 const char *pos = str;
182 while( *pos && !isspace(*pos) )
199 case '\\': // backslash
204 // TODO: \p and \m<msgnum> (for message/disaster_message only)
218 while( isspace(*pos) )
227 static int _get_token_sym_v(const char *str, const char **outstr, bool printError, const char **syms)
230 for( int idx = 0; (sym = syms[idx]); idx ++ )
232 size_t len = strlen(sym);
233 if( memcmp(str, sym, len) != 0 )
235 if( str[len] && !isspace(str[len]) )
240 while( isspace(*str) )
246 // Unknown symbol, find the end of the symbol and error
247 const char *end = str;
248 while( !isspace(*end) )
252 Log_Notice("UDI", "Unknown token '%.*s'", end-str, str);
259 static int _get_token_sym(const char *str, const char **outstr, bool printError, ...)
264 va_start(args, printError);
265 for( ; (sym = va_arg(args, const char *)); count ++ )
269 const char *symlist[count+1];
270 va_start(args, printError);
271 for( int idx = 0; (sym = va_arg(args, const char *)); idx ++ )
273 symlist[count] = NULL;
275 return _get_token_sym_v(str, outstr, printError, symlist);
279 UDIPROPS__properties_version,
285 UDIPROPS__parent_bind_ops,
286 UDIPROPS__internal_bind_ops,
287 UDIPROPS__child_bind_ops,
296 UDIPROPS__enumerates,
300 #define _defpropname(name) [ UDIPROPS__##name ] = #name
301 const char *caUDI_UdipropsNames[] = {
302 _defpropname(properties_version),
303 _defpropname(module),
305 _defpropname(message),
306 _defpropname(locale),
307 _defpropname(region),
308 _defpropname(parent_bind_ops),
309 _defpropname(internal_bind_ops),
310 _defpropname(child_bind_ops),
311 _defpropname(supplier),
312 _defpropname(contact),
314 _defpropname(shortname),
315 _defpropname(release),
316 _defpropname(requires),
318 _defpropname(device),
319 _defpropname(enumerates),
321 [UDIPROPS_last] = NULL
325 tUDI_DriverModule *UDI_int_LoadDriver(void *LoadBase, const udi_init_t *info, const char *udiprops, size_t udiprops_size)
327 //UDI_int_DumpInitInfo(info);
329 // TODO: Multiple modules?
330 tUDI_DriverModule *driver_module = NEW(tUDI_DriverModule,);
331 driver_module->InitInfo = info;
334 const char **udipropsptrs;
337 for( int i = 0; i < udiprops_size; i++ )
339 if( udiprops[i] == '\0' )
343 Log_Debug("UDI", "nLines = %i", nLines);
345 udipropsptrs = NEW(const char*,*nLines);
347 udipropsptrs[line++] = udiprops;
348 for( int i = 0; i < udiprops_size; i++ )
350 if( udiprops[i] == '\0' ) {
351 udipropsptrs[line++] = &udiprops[i+1];
354 if(udipropsptrs[line-1] == &udiprops[udiprops_size])
358 // 'message' into driver_module->Messages
359 // 'region' into driver_module->RegionTypes
360 // 'module' into driver_module->ModuleName
363 for( int i = 0; i < nLines; i ++ )
365 const char *str = udipropsptrs[i];
366 int sym = _get_token_sym_v(str, &str, false, caUDI_UdipropsNames);
369 case UDIPROPS__module:
370 driver_module->ModuleName = str;
373 driver_module->nMetaLangs ++;
375 case UDIPROPS__message:
376 driver_module->nMessages ++;
378 case UDIPROPS__locale:
381 case UDIPROPS__region:
382 driver_module->nRegionTypes ++;
384 case UDIPROPS__device:
385 driver_module->nDevices ++;
387 case UDIPROPS__parent_bind_ops:
388 driver_module->nParents ++;
390 case UDIPROPS__child_bind_ops:
391 driver_module->nChildBindOps ++;
399 // Allocate structures
400 LOG("nMessages = %i, nMetaLangs = %i",
401 driver_module->nMessages,
402 driver_module->nMetaLangs);
403 driver_module->Messages = NEW(tUDI_PropMessage, * driver_module->nMessages);
404 driver_module->RegionTypes = NEW(tUDI_PropRegion, * driver_module->nRegionTypes);
405 driver_module->MetaLangs = NEW(tUDI_MetaLangRef, * driver_module->nMetaLangs);
406 driver_module->Parents = NEW(tUDI_BindOps, * driver_module->nParents);
407 driver_module->ChildBindOps = NEW(tUDI_BindOps, * driver_module->nChildBindOps);
408 driver_module->Devices = NEW(tUDI_PropDevSpec*,* driver_module->nDevices);
411 bool error_hit = false;
415 int parent_index = 0;
416 int child_bind_index = 0;
417 int device_index = 0;
418 int next_unpop_region = 1;
419 for( int i = 0; i < nLines; i ++ )
421 const char *str = udipropsptrs[i];
424 int sym = _get_token_sym_v(str, &str, true, caUDI_UdipropsNames);
427 case UDIPROPS__properties_version:
428 if( _get_token_uint32(str, &str) != 0x101 ) {
429 Log_Warning("UDI", "Properties version mismatch.");
433 case UDIPROPS__module:
434 driver_module->ModuleName = str;
436 case UDIPROPS__meta: {
437 tUDI_MetaLangRef *ml = &driver_module->MetaLangs[ml_index++];
438 ml->meta_idx = _get_token_idx(str, &str);
440 ml->interface_name = str;
441 // TODO: May need to trim trailing spaces
442 ml->metalang = UDI_int_GetMetaLangByName(ml->interface_name);
443 if( !ml->metalang ) {
444 Log_Error("UDI", "Module %s referenced unsupported metalang %s",
445 driver_module->ModuleName, ml->interface_name);
450 case UDIPROPS__message:
452 tUDI_PropMessage *msg = &driver_module->Messages[msg_index++];
453 msg->locale = cur_locale;
454 msg->index = _get_token_uint16(str, &str);
455 if( !str ) continue ;
457 //Log_Debug("UDI", "Message %i/%i: '%s'", msg->locale, msg->index, msg->string);
460 case UDIPROPS__locale:
464 case UDIPROPS__region:
466 udi_index_t rgn_idx = _get_token_idx(str, &str);
467 if( !str ) continue ;
468 // Search for region index (just in case internal_bind_ops appears earlier)
469 tUDI_PropRegion *rgn = &driver_module->RegionTypes[0];
473 for( int i = 1; i < next_unpop_region; i ++, rgn ++ ) {
474 if( rgn->RegionIdx == rgn_idx )
477 if(i == next_unpop_region) {
478 if( next_unpop_region == driver_module->nRegionTypes ) {
479 // TODO: warning if reigon types overflow
482 next_unpop_region ++;
483 rgn->RegionIdx = rgn_idx;
489 int sym = _get_token_sym(str, &str, true,
490 "type", "binding", "priority", "latency", "overrun_time", NULL
496 rgn->Type = _get_token_sym(str, &str, true,
497 "normal", "fp", NULL);
500 rgn->Binding = _get_token_sym(str, &str, true,
501 "static", "dynamic", NULL);
504 rgn->Priority = _get_token_sym(str, &str, true,
505 "med", "lo", "hi", NULL);
508 rgn->Latency = _get_token_sym(str, &str, true,
509 "non_overrunable", "powerfail_warning", "overrunable",
510 "retryable", "non_critical", NULL);
512 case 4: // overrun_time
513 rgn->OverrunTime = _get_token_uint32(str, &str);
520 case UDIPROPS__parent_bind_ops:
522 tUDI_BindOps *bind = &driver_module->Parents[parent_index++];
523 bind->meta_idx = _get_token_idx(str, &str);
524 if( !str ) continue ;
525 bind->region_idx = _get_token_idx(str, &str);
526 if( !str ) continue ;
527 bind->ops_idx = _get_token_idx(str, &str);
528 if( !str ) continue ;
529 bind->bind_cb_idx = _get_token_idx(str, &str);
531 // Expected EOL, didn't get it :(
533 Log_Debug("UDI", "Parent bind - meta:%i,rgn:%i,ops:%i,bind:%i",
534 bind->meta_idx, bind->region_idx, bind->ops_idx, bind->bind_cb_idx);
537 case UDIPROPS__internal_bind_ops:
539 // Get region using index
540 udi_index_t meta = _get_token_idx(str, &str);
541 if( !str ) continue ;
542 udi_index_t rgn_idx = _get_token_idx(str, &str);
543 if( !str ) continue ;
545 // Search for region index (just in case the relevant 'region' comes after)
546 tUDI_PropRegion *rgn = &driver_module->RegionTypes[0];
551 for( j = 1; j < next_unpop_region; j ++, rgn ++ ) {
552 if( rgn->RegionIdx == rgn_idx )
555 if( j == next_unpop_region ) {
556 if( next_unpop_region == driver_module->nRegionTypes ) {
557 // TODO: warning if reigon types overflow
560 next_unpop_region ++;
561 rgn->RegionIdx = rgn_idx;
566 rgn->BindMeta = meta;
568 rgn->PriBindOps = _get_token_idx(str, &str);
569 if( !str ) continue ;
570 rgn->SecBindOps = _get_token_idx(str, &str);
571 if( !str ) continue ;
572 rgn->BindCb = _get_token_idx(str, &str);
573 if( !str ) continue ;
575 // TODO: Please sir, I want an EOL
579 case UDIPROPS__child_bind_ops:
581 tUDI_BindOps *bind = &driver_module->ChildBindOps[child_bind_index++];
582 bind->meta_idx = _get_token_idx(str, &str);
583 if( !str ) continue ;
584 bind->region_idx = _get_token_idx(str, &str);
585 if( !str ) continue ;
586 bind->ops_idx = _get_token_idx(str, &str);
588 // Expected EOL, didn't get it :(
590 Log_Debug("UDI", "Child bind - meta:%i,rgn:%i,ops:%i",
591 bind->meta_idx, bind->region_idx, bind->ops_idx);
594 case UDIPROPS__supplier:
595 case UDIPROPS__contact:
597 case UDIPROPS__shortname:
598 case UDIPROPS__release:
600 //case UDIPROPS__requires:
603 case UDIPROPS__device:
606 // Count properties (and validate)
607 _get_token_idx(str, &str); // message
609 _get_token_idx(str, &str); // meta
613 _get_token_str(str, &str, NULL);
615 _get_token_sym(str, &str, true, "string", "ubit32", "boolean", "array", NULL);
617 _get_token_str(str, &str, NULL);
621 // Rewind and actually parse
622 _get_token_str(udipropsptrs[i], &str, NULL);
624 tUDI_PropDevSpec *dev = NEW_wA(tUDI_PropDevSpec, Attribs, n_attr);
625 driver_module->Devices[device_index++] = dev;;
626 dev->MessageNum = _get_token_idx(str, &str);
627 dev->MetaIdx = _get_token_idx(str, &str);
628 dev->nAttribs = n_attr;
632 udi_instance_attr_list_t *at = &dev->Attribs[n_attr];
633 _get_token_str(str, &str, at->attr_name);
635 at->attr_type = _get_token_sym(str, &str, true,
636 " ", "string", "array", "ubit32", "boolean", NULL);
639 switch( dev->Attribs[n_attr].attr_type )
642 at->attr_length = _get_token_str(str, &str, (char*)at->attr_value);
646 Log_Warning("UDI", "TODO: Parse 'array' attribute in 'device'");
647 _get_token_str(str, &str, NULL);
651 at->attr_length = sizeof(udi_ubit32_t);
652 val = _get_token_uint32(str, &str);
653 Log_Debug("UDI", "device %i: Value '%s'=%x", device_index,
655 UDI_ATTR32_SET(at->attr_value, val);
658 at->attr_length = sizeof(udi_boolean_t);
659 UDI_ATTR32_SET(at->attr_value, _get_token_bool(str, &str));
669 Log_Debug("UDI", "udipropsptrs[%i] = '%s'", i, udipropsptrs[i]);
675 Log_Error("UDI", "Error encountered while parsing udiprops for '%s' (%p), bailing",
676 driver_module->ModuleName, LoadBase);
677 for( int i = 0; i < device_index; i ++ )
678 free(driver_module->Devices[i]);
679 free(driver_module->Messages);
680 free(driver_module->RegionTypes);
681 free(driver_module->MetaLangs);
682 free(driver_module->Parents);
683 free(driver_module->ChildBindOps);
684 free(driver_module->Devices);
689 for( int i = 0; i < driver_module->nDevices; i ++ )
690 driver_module->Devices[i]->Metalang = UDI_int_GetMetaLang(driver_module,
691 driver_module->Devices[i]->MetaIdx);
694 // TODO: Sort message list
696 int nSecondaryRgns = 0;
697 for( int i = 0; info->secondary_init_list && info->secondary_init_list[i].region_idx; i ++ )
699 driver_module->nRegions = 1+nSecondaryRgns;
702 // -- Add to loaded module list
703 driver_module->Next = gpUDI_LoadedModules;
704 gpUDI_LoadedModules = driver_module;
706 // Check for orphan drivers, and create an instance of them when loaded
707 if( driver_module->nParents == 0 )
709 UDI_MA_CreateInstance(driver_module, NULL, NULL);
713 // Search running instances for unbound children that can be bound to this driver
714 UDI_MA_BindParents(driver_module);
717 return driver_module;
720 void UDI_int_DumpInitInfo(udi_init_t *info)
722 Log("primary_init_info = %p = {", info->primary_init_info);
724 Log(" .mgmt_ops = %p = {", info->primary_init_info->mgmt_ops);
725 Log(" .usage_ind_op: %p() - 0x%02x",
726 info->primary_init_info->mgmt_ops->usage_ind_op,
727 info->primary_init_info->mgmt_op_flags[0]
729 Log(" .enumerate_req_op: %p() - 0x%02x",
730 info->primary_init_info->mgmt_ops->enumerate_req_op,
731 info->primary_init_info->mgmt_op_flags[1]
733 Log(" .devmgmt_req_op: %p() - 0x%02x",
734 info->primary_init_info->mgmt_ops->devmgmt_req_op,
735 info->primary_init_info->mgmt_op_flags[2]
737 Log(" .final_cleanup_req_op: %p() - 0x%02x",
738 info->primary_init_info->mgmt_ops->final_cleanup_req_op,
739 info->primary_init_info->mgmt_op_flags[3]
742 Log(" .mgmt_scratch_requirement = 0x%x", info->primary_init_info->mgmt_scratch_requirement);
743 Log(" .enumeration_attr_list_length = 0x%x", info->primary_init_info->enumeration_attr_list_length);
744 Log(" .rdata_size = 0x%x", info->primary_init_info->rdata_size);
745 Log(" .child_data_size = 0x%x", info->primary_init_info->child_data_size);
746 Log(" .per_parent_paths = 0x%x", info->primary_init_info->per_parent_paths);
749 Log("secondary_init_list = %p {", info->secondary_init_list);
750 for( int i = 0; info->secondary_init_list && info->secondary_init_list[i].region_idx; i ++ )
752 Log(" [%i] = { .region_idx=%i, .rdata_size=0x%x }",
753 info->secondary_init_list[i].region_idx, info->secondary_init_list[i].rdata_size);
756 Log("ops_init_list = %p {", info->ops_init_list);
757 for( int i = 0; info->ops_init_list[i].ops_idx; i++ )
760 Log(" .ops_idx = 0x%x", info->ops_init_list[i].ops_idx);
761 Log(" .meta_idx = 0x%x", info->ops_init_list[i].meta_idx);
762 Log(" .meta_ops_num = 0x%x", info->ops_init_list[i].meta_ops_num);
763 Log(" .chan_context_size = 0x%x", info->ops_init_list[i].chan_context_size);
764 Log(" .ops_vector = %p", info->ops_init_list[i].ops_vector);
765 // Log(" .op_flags = %p", info->ops_init_list[i].op_flags);
769 Log("cb_init_list = %p {", info->cb_init_list);
770 for( int i = 0; info->cb_init_list[i].cb_idx; i++ )
772 udi_cb_init_t *ent = &info->cb_init_list[i];
774 Log(" .cbidx = %i", ent->cb_idx);
775 Log(" .meta_idx = %i", ent->meta_idx);
776 Log(" .meta_cb_num = %i", ent->meta_cb_num);
777 Log(" .scratch_requirement = 0x%x", ent->scratch_requirement);
778 Log(" .inline_size = 0x%x", ent->inline_size);
779 Log(" .inline_layout = %p", ent->inline_layout);
784 // TODO: Move this stuff out
785 udi_ops_init_t *UDI_int_GetOps(tUDI_DriverInstance *Inst, udi_index_t index)
787 udi_ops_init_t *ops = Inst->Module->InitInfo->ops_init_list;
788 while( ops->ops_idx && ops->ops_idx != index )
790 if(ops->ops_idx == 0)
795 tUDI_MetaLang *UDI_int_GetMetaLang(tUDI_DriverModule *Module, udi_index_t index)
798 return &cMetaLang_Management;
800 for( int i = 0; i < Module->nMetaLangs; i ++ )
802 if( Module->MetaLangs[i].meta_idx == index )
803 return Module->MetaLangs[i].metalang;
808 const tUDI_MetaLang *UDI_int_GetMetaLangByName(const char *Name)
810 //extern tUDI_MetaLang cMetaLang_Management;
811 extern tUDI_MetaLang cMetaLang_BusBridge;
812 extern tUDI_MetaLang cMetaLang_GIO;
813 extern tUDI_MetaLang cMetaLang_NIC;
814 const tUDI_MetaLang *langs[] = {
815 &cMetaLang_BusBridge,
820 for( int i = 0; langs[i]; i ++ )
822 if( strcmp(Name, langs[i]->Name) == 0 )