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, const char *ArgumentString);
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, const char *ArgumentString)
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);
93 // TODO: Parse 'ArgumentString' and extract properties for module/instances
94 // - Including debug flag
99 static udi_boolean_t _get_token_bool(const char *str, const char **outstr)
116 while( isspace(*str) )
121 static udi_index_t _get_token_idx(const char *str, const char **outstr)
124 unsigned long ret = strtoul(str, &end, 10);
126 Log_Notice("UDI", "Value '%.*s' (0x%lx) out of range for udi_index_t",
131 if( *end && !isspace(*end) ) {
132 Log_Notice("UDI", "No whitespace following '%.*s', got '%c'",
137 while( *end && isspace(*end) )
143 static udi_ubit16_t _get_token_uint16(const char *str, const char **outstr)
146 unsigned long ret = strtoul(str, &end, 10);
148 Log_Notice("UDI", "Value '%.*s' (0x%lx) out of range for udi_ubit16_t",
153 if( *end && !isspace(*end) ) {
154 Log_Notice("UDI", "No whitespace following '%.*s', got '%c'",
159 while( *end && isspace(*end) )
165 static udi_ubit32_t _get_token_uint32(const char *str, const char **outstr)
168 udi_ubit32_t ret = strtoul(str, &end, 0);
169 if( *end && !isspace(*end) ) {
170 Log_Notice("UDI", "No whitespace following '%.*s', got '%c'",
175 while( *end && isspace(*end) )
181 static size_t _get_token_str(const char *str, const char **outstr, char *output)
184 const char *pos = str;
185 while( *pos && !isspace(*pos) )
202 case '\\': // backslash
207 // TODO: \p and \m<msgnum> (for message/disaster_message only)
221 while( isspace(*pos) )
230 static int _get_token_sym_v(const char *str, const char **outstr, bool printError, const char **syms)
233 for( int idx = 0; (sym = syms[idx]); idx ++ )
235 size_t len = strlen(sym);
236 if( memcmp(str, sym, len) != 0 )
238 if( str[len] && !isspace(str[len]) )
243 while( isspace(*str) )
249 // Unknown symbol, find the end of the symbol and error
250 const char *end = str;
251 while( !isspace(*end) )
255 Log_Notice("UDI", "Unknown token '%.*s'", end-str, str);
262 static int _get_token_sym(const char *str, const char **outstr, bool printError, ...)
267 va_start(args, printError);
268 for( ; (sym = va_arg(args, const char *)); count ++ )
272 const char *symlist[count+1];
273 va_start(args, printError);
274 for( int idx = 0; (sym = va_arg(args, const char *)); idx ++ )
276 symlist[count] = NULL;
278 return _get_token_sym_v(str, outstr, printError, symlist);
282 UDIPROPS__properties_version,
288 UDIPROPS__parent_bind_ops,
289 UDIPROPS__internal_bind_ops,
290 UDIPROPS__child_bind_ops,
299 UDIPROPS__enumerates,
303 #define _defpropname(name) [ UDIPROPS__##name ] = #name
304 const char *caUDI_UdipropsNames[] = {
305 _defpropname(properties_version),
306 _defpropname(module),
308 _defpropname(message),
309 _defpropname(locale),
310 _defpropname(region),
311 _defpropname(parent_bind_ops),
312 _defpropname(internal_bind_ops),
313 _defpropname(child_bind_ops),
314 _defpropname(supplier),
315 _defpropname(contact),
317 _defpropname(shortname),
318 _defpropname(release),
319 _defpropname(requires),
321 _defpropname(device),
322 _defpropname(enumerates),
324 [UDIPROPS_last] = NULL
328 tUDI_DriverModule *UDI_int_LoadDriver(void *LoadBase, const udi_init_t *info, const char *udiprops, size_t udiprops_size)
330 //UDI_int_DumpInitInfo(info);
332 // TODO: Multiple modules?
333 tUDI_DriverModule *driver_module = NEW(tUDI_DriverModule,);
334 driver_module->InitInfo = info;
337 const char **udipropsptrs;
340 for( int i = 0; i < udiprops_size; i++ )
342 if( udiprops[i] == '\0' )
346 Log_Debug("UDI", "nLines = %i", nLines);
348 udipropsptrs = NEW(const char*,*nLines);
350 udipropsptrs[line++] = udiprops;
351 for( int i = 0; i < udiprops_size; i++ )
353 if( udiprops[i] == '\0' ) {
354 udipropsptrs[line++] = &udiprops[i+1];
357 if(udipropsptrs[line-1] == &udiprops[udiprops_size])
361 // 'message' into driver_module->Messages
362 // 'region' into driver_module->RegionTypes
363 // 'module' into driver_module->ModuleName
366 for( int i = 0; i < nLines; i ++ )
368 const char *str = udipropsptrs[i];
369 int sym = _get_token_sym_v(str, &str, false, caUDI_UdipropsNames);
372 case UDIPROPS__module:
373 driver_module->ModuleName = str;
376 driver_module->nMetaLangs ++;
378 case UDIPROPS__message:
379 driver_module->nMessages ++;
381 case UDIPROPS__locale:
384 case UDIPROPS__region:
385 driver_module->nRegionTypes ++;
387 case UDIPROPS__device:
388 driver_module->nDevices ++;
390 case UDIPROPS__parent_bind_ops:
391 driver_module->nParents ++;
393 case UDIPROPS__child_bind_ops:
394 driver_module->nChildBindOps ++;
402 // Allocate structures
403 LOG("nMessages = %i, nMetaLangs = %i",
404 driver_module->nMessages,
405 driver_module->nMetaLangs);
406 driver_module->Messages = NEW(tUDI_PropMessage, * driver_module->nMessages);
407 driver_module->RegionTypes = NEW(tUDI_PropRegion, * driver_module->nRegionTypes);
408 driver_module->MetaLangs = NEW(tUDI_MetaLangRef, * driver_module->nMetaLangs);
409 driver_module->Parents = NEW(tUDI_BindOps, * driver_module->nParents);
410 driver_module->ChildBindOps = NEW(tUDI_BindOps, * driver_module->nChildBindOps);
411 driver_module->Devices = NEW(tUDI_PropDevSpec*,* driver_module->nDevices);
414 bool error_hit = false;
418 int parent_index = 0;
419 int child_bind_index = 0;
420 int device_index = 0;
421 int next_unpop_region = 1;
422 #define IF_ERROR(op) if(!str){error_hit=1;op;}
423 for( int i = 0; i < nLines; i ++ )
425 const char *str = udipropsptrs[i];
428 int sym = _get_token_sym_v(str, &str, true, caUDI_UdipropsNames);
429 //LOG("Processing option '%s'", (sym >= 0 ? caUDI_UdipropsNames[sym] : "ERR"));
432 case UDIPROPS__properties_version:
433 if( _get_token_uint32(str, &str) != 0x101 ) {
434 Log_Warning("UDI", "Properties version mismatch.");
438 case UDIPROPS__module:
439 driver_module->ModuleName = str;
441 case UDIPROPS__meta: {
442 tUDI_MetaLangRef *ml = &driver_module->MetaLangs[ml_index++];
443 ml->meta_idx = _get_token_idx(str, &str);
445 ml->interface_name = str;
446 // TODO: May need to trim trailing spaces
447 ml->metalang = UDI_int_GetMetaLangByName(ml->interface_name);
448 if( !ml->metalang ) {
449 Log_Error("UDI", "Module %s referenced unsupported metalang %s",
450 driver_module->ModuleName, ml->interface_name);
455 case UDIPROPS__message:
457 tUDI_PropMessage *msg = &driver_module->Messages[msg_index++];
458 msg->locale = cur_locale;
459 msg->index = _get_token_uint16(str, &str);
462 //Log_Debug("UDI", "Message %i/%i: '%s'", msg->locale, msg->index, msg->string);
465 case UDIPROPS__locale:
469 case UDIPROPS__region:
471 udi_index_t rgn_idx = _get_token_idx(str, &str);
473 // Search for region index (just in case internal_bind_ops appears earlier)
474 tUDI_PropRegion *rgn = &driver_module->RegionTypes[0];
478 for( int i = 1; i < next_unpop_region; i ++, rgn ++ ) {
479 if( rgn->RegionIdx == rgn_idx )
482 if(i == next_unpop_region) {
483 if( next_unpop_region == driver_module->nRegionTypes ) {
484 // TODO: warning if reigon types overflow
487 next_unpop_region ++;
488 rgn->RegionIdx = rgn_idx;
494 int sym = _get_token_sym(str, &str, true,
495 "type", "binding", "priority", "latency", "overrun_time", NULL
501 rgn->Type = _get_token_sym(str, &str, true,
502 "normal", "fp", NULL);
505 rgn->Binding = _get_token_sym(str, &str, true,
506 "static", "dynamic", NULL);
509 rgn->Priority = _get_token_sym(str, &str, true,
510 "med", "lo", "hi", NULL);
513 rgn->Latency = _get_token_sym(str, &str, true,
514 "non_overrunable", "powerfail_warning", "overrunable",
515 "retryable", "non_critical", NULL);
517 case 4: // overrun_time
518 rgn->OverrunTime = _get_token_uint32(str, &str);
525 case UDIPROPS__parent_bind_ops:
527 tUDI_BindOps *bind = &driver_module->Parents[parent_index++];
528 bind->meta_idx = _get_token_idx(str, &str);
530 bind->region_idx = _get_token_idx(str, &str);
532 bind->ops_idx = _get_token_idx(str, &str);
534 bind->bind_cb_idx = _get_token_idx(str, &str);
537 // Expected EOL, didn't get it :(
539 Log_Debug("UDI", "Parent bind - meta:%i,rgn:%i,ops:%i,bind:%i",
540 bind->meta_idx, bind->region_idx, bind->ops_idx, bind->bind_cb_idx);
543 case UDIPROPS__internal_bind_ops:
545 // Get region using index
546 udi_index_t meta = _get_token_idx(str, &str);
548 udi_index_t rgn_idx = _get_token_idx(str, &str);
551 // Search for region index (just in case the relevant 'region' comes after)
552 tUDI_PropRegion *rgn = &driver_module->RegionTypes[0];
557 for( j = 1; j < next_unpop_region; j ++, rgn ++ ) {
558 if( rgn->RegionIdx == rgn_idx )
561 if( j == next_unpop_region ) {
562 if( next_unpop_region == driver_module->nRegionTypes ) {
563 // TODO: warning if reigon types overflow
566 next_unpop_region ++;
567 rgn->RegionIdx = rgn_idx;
572 rgn->BindMeta = meta;
574 rgn->PriBindOps = _get_token_idx(str, &str);
576 rgn->SecBindOps = _get_token_idx(str, &str);
578 rgn->BindCb = _get_token_idx(str, &str);
581 // TODO: Please sir, I want an EOL
585 case UDIPROPS__child_bind_ops:
587 tUDI_BindOps *bind = &driver_module->ChildBindOps[child_bind_index++];
588 bind->meta_idx = _get_token_idx(str, &str);
590 bind->region_idx = _get_token_idx(str, &str);
592 bind->ops_idx = _get_token_idx(str, &str);
595 // Expected EOL, didn't get it :(
597 Log_Debug("UDI", "Child bind - meta:%i,rgn:%i,ops:%i",
598 bind->meta_idx, bind->region_idx, bind->ops_idx);
601 case UDIPROPS__supplier:
602 case UDIPROPS__contact:
604 case UDIPROPS__shortname:
605 case UDIPROPS__release:
607 //case UDIPROPS__requires:
610 case UDIPROPS__device:
613 // Count properties (and validate)
614 _get_token_uint16(str, &str); // message
616 _get_token_idx(str, &str); // meta
620 _get_token_str(str, &str, NULL);
622 _get_token_sym(str, &str, true, "string", "ubit32", "boolean", "array", NULL);
624 _get_token_str(str, &str, NULL);
628 // Rewind and actually parse
629 // - Eat the 'device' token and hence reset 'str'
630 _get_token_str(udipropsptrs[i], &str, NULL);
632 tUDI_PropDevSpec *dev = NEW_wA(tUDI_PropDevSpec, Attribs, n_attr);
633 driver_module->Devices[device_index++] = dev;;
634 dev->MessageNum = _get_token_uint16(str, &str);
635 dev->MetaIdx = _get_token_idx(str, &str);
636 dev->nAttribs = n_attr;
640 udi_instance_attr_list_t *at = &dev->Attribs[n_attr];
641 _get_token_str(str, &str, at->attr_name);
643 at->attr_type = _get_token_sym(str, &str, true,
644 " ", "string", "array", "ubit32", "boolean", NULL);
647 switch( dev->Attribs[n_attr].attr_type )
650 at->attr_length = _get_token_str(str, &str, (char*)at->attr_value);
654 Log_Warning("UDI", "TODO: Parse 'array' attribute in 'device'");
655 _get_token_str(str, &str, NULL);
659 at->attr_length = sizeof(udi_ubit32_t);
660 val = _get_token_uint32(str, &str);
661 Log_Debug("UDI", "device %i: Value '%s'=%x", device_index,
663 UDI_ATTR32_SET(at->attr_value, val);
666 at->attr_length = sizeof(udi_boolean_t);
667 UDI_ATTR32_SET(at->attr_value, _get_token_bool(str, &str));
677 Log_Debug("UDI", "udipropsptrs[%i] = '%s'", i, udipropsptrs[i]);
683 Log_Error("UDI", "Error encountered while parsing udiprops for '%s' (LoadBase=%p), bailing",
684 driver_module->ModuleName, LoadBase);
685 for( int i = 0; i < device_index; i ++ )
686 free(driver_module->Devices[i]);
687 free(driver_module->Messages);
688 free(driver_module->RegionTypes);
689 free(driver_module->MetaLangs);
690 free(driver_module->Parents);
691 free(driver_module->ChildBindOps);
692 free(driver_module->Devices);
696 ASSERTC(device_index, ==, driver_module->nDevices);
698 for( int i = 0; i < driver_module->nDevices; i ++ ) {
699 ASSERT(driver_module);
700 ASSERT(driver_module->Devices[i]);
701 driver_module->Devices[i]->Metalang = UDI_int_GetMetaLang(driver_module,
702 driver_module->Devices[i]->MetaIdx);
706 // TODO: Sort message list
708 int nSecondaryRgns = 0;
709 for( int i = 0; info->secondary_init_list && info->secondary_init_list[i].region_idx; i ++ )
711 driver_module->nRegions = 1+nSecondaryRgns;
714 // -- Add to loaded module list
715 driver_module->Next = gpUDI_LoadedModules;
716 gpUDI_LoadedModules = driver_module;
718 // Check for orphan drivers, and create an instance of them when loaded
719 if( driver_module->nParents == 0 )
721 UDI_MA_CreateInstance(driver_module, NULL, NULL);
725 // Search running instances for unbound children that can be bound to this driver
726 UDI_MA_BindParents(driver_module);
729 return driver_module;
732 void UDI_int_DumpInitInfo(udi_init_t *info)
734 Log("primary_init_info = %p = {", info->primary_init_info);
736 Log(" .mgmt_ops = %p = {", info->primary_init_info->mgmt_ops);
737 Log(" .usage_ind_op: %p() - 0x%02x",
738 info->primary_init_info->mgmt_ops->usage_ind_op,
739 info->primary_init_info->mgmt_op_flags[0]
741 Log(" .enumerate_req_op: %p() - 0x%02x",
742 info->primary_init_info->mgmt_ops->enumerate_req_op,
743 info->primary_init_info->mgmt_op_flags[1]
745 Log(" .devmgmt_req_op: %p() - 0x%02x",
746 info->primary_init_info->mgmt_ops->devmgmt_req_op,
747 info->primary_init_info->mgmt_op_flags[2]
749 Log(" .final_cleanup_req_op: %p() - 0x%02x",
750 info->primary_init_info->mgmt_ops->final_cleanup_req_op,
751 info->primary_init_info->mgmt_op_flags[3]
754 Log(" .mgmt_scratch_requirement = 0x%x", info->primary_init_info->mgmt_scratch_requirement);
755 Log(" .enumeration_attr_list_length = 0x%x", info->primary_init_info->enumeration_attr_list_length);
756 Log(" .rdata_size = 0x%x", info->primary_init_info->rdata_size);
757 Log(" .child_data_size = 0x%x", info->primary_init_info->child_data_size);
758 Log(" .per_parent_paths = 0x%x", info->primary_init_info->per_parent_paths);
761 Log("secondary_init_list = %p {", info->secondary_init_list);
762 for( int i = 0; info->secondary_init_list && info->secondary_init_list[i].region_idx; i ++ )
764 Log(" [%i] = { .region_idx=%i, .rdata_size=0x%x }",
765 info->secondary_init_list[i].region_idx, info->secondary_init_list[i].rdata_size);
768 Log("ops_init_list = %p {", info->ops_init_list);
769 for( int i = 0; info->ops_init_list[i].ops_idx; i++ )
772 Log(" .ops_idx = 0x%x", info->ops_init_list[i].ops_idx);
773 Log(" .meta_idx = 0x%x", info->ops_init_list[i].meta_idx);
774 Log(" .meta_ops_num = 0x%x", info->ops_init_list[i].meta_ops_num);
775 Log(" .chan_context_size = 0x%x", info->ops_init_list[i].chan_context_size);
776 Log(" .ops_vector = %p", info->ops_init_list[i].ops_vector);
777 // Log(" .op_flags = %p", info->ops_init_list[i].op_flags);
781 Log("cb_init_list = %p {", info->cb_init_list);
782 for( int i = 0; info->cb_init_list[i].cb_idx; i++ )
784 udi_cb_init_t *ent = &info->cb_init_list[i];
786 Log(" .cbidx = %i", ent->cb_idx);
787 Log(" .meta_idx = %i", ent->meta_idx);
788 Log(" .meta_cb_num = %i", ent->meta_cb_num);
789 Log(" .scratch_requirement = 0x%x", ent->scratch_requirement);
790 Log(" .inline_size = 0x%x", ent->inline_size);
791 Log(" .inline_layout = %p", ent->inline_layout);
796 // TODO: Move this stuff out
797 udi_ops_init_t *UDI_int_GetOps(tUDI_DriverInstance *Inst, udi_index_t index)
799 udi_ops_init_t *ops = Inst->Module->InitInfo->ops_init_list;
800 while( ops->ops_idx && ops->ops_idx != index )
802 if(ops->ops_idx == 0)
807 tUDI_MetaLang *UDI_int_GetMetaLang(tUDI_DriverModule *Module, udi_index_t index)
810 return &cMetaLang_Management;
812 for( int i = 0; i < Module->nMetaLangs; i ++ )
814 if( Module->MetaLangs[i].meta_idx == index )
815 return Module->MetaLangs[i].metalang;
820 const tUDI_MetaLang *UDI_int_GetMetaLangByName(const char *Name)
822 //extern tUDI_MetaLang cMetaLang_Management;
823 extern tUDI_MetaLang cMetaLang_BusBridge;
824 extern tUDI_MetaLang cMetaLang_GIO;
825 extern tUDI_MetaLang cMetaLang_NIC;
826 const tUDI_MetaLang *langs[] = {
827 &cMetaLang_BusBridge,
832 for( int i = 0; langs[i]; i ++ )
834 if( strcmp(Name, langs[i]->Name) == 0 )