]> code.delx.au - refind/blobdiff - refind/config.c
TianoCore build support; new use_graphics_for refind.conf token
[refind] / refind / config.c
index 803ce61bde5bf852bbc1e5fdc070ce2204163a5d..eb5040c5b59085db4b5eb61f1983d635f5c451ea 100644 (file)
 #include "menu.h"
 #include "config.h"
 #include "screen.h"
-#include "refit_call_wrapper.h"
+#include "../include/refit_call_wrapper.h"
 
 // constants
 
 #define CONFIG_FILE_NAME         L"refind.conf"
-#define LINUX_OPTIONS_FILENAMES  L"refind_linux.conf,refind-linux.conf,linux.conf"
+#define LINUX_OPTIONS_FILENAMES  L"refind_linux.conf,refind-linux.conf"
 #define MAXCONFIGFILESIZE        (128*1024)
 
 #define ENCODING_ISO8859_1  (0)
@@ -81,7 +81,7 @@ static EFI_STATUS ReadFile(IN EFI_FILE_HANDLE BaseDir, CHAR16 *FileName, REFIT_F
     Status = refit_call5_wrapper(BaseDir->Open, BaseDir, &FileHandle, FileName, EFI_FILE_MODE_READ, 0);
     if (CheckError(Status, L"while loading the configuration file"))
         return Status;
-    
+
     FileInfo = LibFileInfo(FileHandle);
     if (FileInfo == NULL) {
         // TODO: print and register the error
@@ -92,7 +92,7 @@ static EFI_STATUS ReadFile(IN EFI_FILE_HANDLE BaseDir, CHAR16 *FileName, REFIT_F
     if (ReadSize > MAXCONFIGFILESIZE)
         ReadSize = MAXCONFIGFILESIZE;
     FreePool(FileInfo);
-    
+
     File->BufferSize = (UINTN)ReadSize;   // was limited to a few K before, so this is safe
     File->Buffer = AllocatePool(File->BufferSize);
     Status = refit_call3_wrapper(FileHandle->Read, FileHandle, &File->BufferSize, File->Buffer);
@@ -103,13 +103,13 @@ static EFI_STATUS ReadFile(IN EFI_FILE_HANDLE BaseDir, CHAR16 *FileName, REFIT_F
         return Status;
     }
     Status = refit_call1_wrapper(FileHandle->Close, FileHandle);
-    
+
     // setup for reading
     File->Current8Ptr  = (CHAR8 *)File->Buffer;
     File->End8Ptr      = File->Current8Ptr + File->BufferSize;
     File->Current16Ptr = (CHAR16 *)File->Buffer;
     File->End16Ptr     = File->Current16Ptr + (File->BufferSize >> 1);
-    
+
     // detect encoding
     File->Encoding = ENCODING_ISO8859_1;   // default: 1:1 translation of CHAR8 to CHAR16
     if (File->BufferSize >= 4) {
@@ -126,7 +126,7 @@ static EFI_STATUS ReadFile(IN EFI_FILE_HANDLE BaseDir, CHAR16 *FileName, REFIT_F
         }
         // TODO: detect other encodings as they are implemented
     }
-    
     return EFI_SUCCESS;
 }
 
@@ -138,18 +138,18 @@ static CHAR16 *ReadLine(REFIT_FILE *File)
 {
     CHAR16  *Line, *q;
     UINTN   LineLength;
-    
+
     if (File->Buffer == NULL)
         return NULL;
-    
+
     if (File->Encoding == ENCODING_ISO8859_1 || File->Encoding == ENCODING_UTF8) {
-        
+
         CHAR8 *p, *LineStart, *LineEnd;
-        
+
         p = File->Current8Ptr;
         if (p >= File->End8Ptr)
             return NULL;
-        
+
         LineStart = p;
         for (; p < File->End8Ptr; p++)
             if (*p == 13 || *p == 10)
@@ -159,12 +159,12 @@ static CHAR16 *ReadLine(REFIT_FILE *File)
             if (*p != 13 && *p != 10)
                 break;
         File->Current8Ptr = p;
-        
+
         LineLength = (UINTN)(LineEnd - LineStart) + 1;
         Line = AllocatePool(LineLength * sizeof(CHAR16));
         if (Line == NULL)
             return NULL;
-        
+
         q = Line;
         if (File->Encoding == ENCODING_ISO8859_1) {
             for (p = LineStart; p < LineEnd; )
@@ -175,15 +175,15 @@ static CHAR16 *ReadLine(REFIT_FILE *File)
                 *q++ = *p++;
         }
         *q = 0;
-        
+
     } else if (File->Encoding == ENCODING_UTF16_LE) {
-        
+
         CHAR16 *p, *LineStart, *LineEnd;
-        
+
         p = File->Current16Ptr;
         if (p >= File->End16Ptr)
             return NULL;
-        
+
         LineStart = p;
         for (; p < File->End16Ptr; p++)
             if (*p == 13 || *p == 10)
@@ -193,19 +193,19 @@ static CHAR16 *ReadLine(REFIT_FILE *File)
             if (*p != 13 && *p != 10)
                 break;
         File->Current16Ptr = p;
-        
+
         LineLength = (UINTN)(LineEnd - LineStart) + 1;
         Line = AllocatePool(LineLength * sizeof(CHAR16));
         if (Line == NULL)
             return NULL;
-        
+
         for (p = LineStart, q = Line; p < LineEnd; )
             *q++ = *p++;
         *q = 0;
-        
+
     } else
         return NULL;   // unsupported encoding
-    
+
     return Line;
 }
 
@@ -252,10 +252,10 @@ UINTN ReadTokenLine(IN REFIT_FILE *File, OUT CHAR16 ***TokenList)
             if (*p == 0 || *p == '#')
                 LineFinished = TRUE;
             *p++ = 0;
-            
+
             AddListElement((VOID ***)TokenList, &TokenCount, (VOID *)StrDuplicate(Token));
         }
-        
+
         FreePool(Line);
     }
     return (TokenCount);
@@ -267,40 +267,39 @@ VOID FreeTokenLine(IN OUT CHAR16 ***TokenList, IN OUT UINTN *TokenCount)
     FreeList((VOID ***)TokenList, TokenCount);
 }
 
-//
 // handle a parameter with a single integer argument
-//
-
 static VOID HandleInt(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT UINTN *Value)
 {
-    if (TokenCount < 2) {
-        return;
-    }
-    if (TokenCount > 2) {
-        return;
-    }
-    *Value = Atoi(TokenList[1]);
+    if (TokenCount == 2)
+       *Value = Atoi(TokenList[1]);
 }
 
-//
 // handle a parameter with a single string argument
-//
+static VOID HandleString(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT CHAR16 **Target) {
+   if (TokenCount == 2) {
+      if (*Target != NULL)
+         FreePool(*Target);
+      *Target = StrDuplicate(TokenList[1]);
+   } // if
+} // static VOID HandleString()
 
-static VOID HandleString(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT CHAR16 **Value)
-{
-    if (TokenCount < 2) {
-        return;
-    }
-    if (TokenCount > 2) {
-        return;
-    }
-    *Value = StrDuplicate(TokenList[1]);
-}
+// Handle a parameter with a series of string arguments, to be added to a comma-delimited
+// list. Passes each token through the CleanUpPathNameSlashes() function to ensure
+// consistency in subsequent comparisons of filenames.
+static VOID HandleStrings(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT CHAR16 **Target) {
+   UINTN i;
 
-//
-// read config file
-//
+   if (*Target != NULL) {
+      FreePool(*Target);
+      *Target = NULL;
+   } // if
+   for (i = 1; i < TokenCount; i++) {
+      CleanUpPathNameSlashes(TokenList[i]);
+      MergeStrings(Target, TokenList[i], L',');
+   }
+} // static VOID HandleStrings()
 
+// read config file
 VOID ReadConfig(VOID)
 {
     EFI_STATUS      Status;
@@ -322,15 +321,11 @@ VOID ReadConfig(VOID)
         TokenCount = ReadTokenLine(&File, &TokenList);
         if (TokenCount == 0)
             break;
-        
+
         if (StriCmp(TokenList[0], L"timeout") == 0) {
             HandleInt(TokenList, TokenCount, &(GlobalConfig.Timeout));
 
-        // Note: I'm using "disable" as equivalent to "hideui" for the moment (as of rEFInd 0.2.4)
-        // because I've folded two options into one and removed some values, so I want to catch
-        // existing configurations as much as possible. The "disable" equivalency to "hideui" will
-        // be removed sooner or later, leaving only "hideui".
-        } else if ((StriCmp(TokenList[0], L"hideui") == 0) || (StriCmp(TokenList[0], L"disable") == 0)) {
+        } else if (StriCmp(TokenList[0], L"hideui") == 0) {
             for (i = 1; i < TokenCount; i++) {
                 FlagName = TokenList[i];
                 if (StriCmp(FlagName, L"banner") == 0) {
@@ -346,10 +341,13 @@ VOID ReadConfig(VOID)
                 } else if (StriCmp(FlagName, L"all") == 0) {
                     GlobalConfig.HideUIFlags = HIDEUI_ALL;
                 } else {
-                    Print(L" unknown disable flag: '%s'\n", FlagName);
+                    Print(L" unknown hideui flag: '%s'\n", FlagName);
                 }
             }
 
+        } else if (StriCmp(TokenList[0], L"icons_dir") == 0) {
+           HandleString(TokenList, TokenCount, &(GlobalConfig.IconsDir));
+
         } else if (StriCmp(TokenList[0], L"scanfor") == 0) {
            for (i = 0; i < NUM_SCAN_OPTIONS; i++) {
               if (i < TokenCount)
@@ -357,6 +355,16 @@ VOID ReadConfig(VOID)
               else
                  GlobalConfig.ScanFor[i] = ' ';
            }
+
+        } else if (StriCmp(TokenList[0], L"also_scan_dirs") == 0) {
+            HandleStrings(TokenList, TokenCount, &(GlobalConfig.AlsoScan));
+
+        } else if ((StriCmp(TokenList[0], L"don't_scan_dirs") == 0) || (StriCmp(TokenList[0], L"dont_scan_dirs") == 0)) {
+            HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScan));
+
+        } else if (StriCmp(TokenList[0], L"scan_driver_dirs") == 0) {
+            HandleStrings(TokenList, TokenCount, &(GlobalConfig.DriverDirs));
+
         } else if (StriCmp(TokenList[0], L"showtools") == 0) {
             SetMem(GlobalConfig.ShowTools, NUM_TOOLS * sizeof(UINTN), 0);
             for (i = 1; (i < TokenCount) && (i < NUM_TOOLS); i++) {
@@ -374,30 +382,50 @@ VOID ReadConfig(VOID)
                 } else if (StriCmp(FlagName, L"shutdown") == 0) {
                    GlobalConfig.ShowTools[i - 1] = TAG_SHUTDOWN;
                 } else {
-                    Print(L" unknown showtools flag: '%s'\n", FlagName);
+                   Print(L" unknown showtools flag: '%s'\n", FlagName);
                 }
             } // showtools options
 
         } else if (StriCmp(TokenList[0], L"banner") == 0) {
-            HandleString(TokenList, TokenCount, &(GlobalConfig.BannerFileName));
+           HandleString(TokenList, TokenCount, &(GlobalConfig.BannerFileName));
 
         } else if (StriCmp(TokenList[0], L"selection_small") == 0) {
-            HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionSmallFileName));
+           HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionSmallFileName));
 
         } else if (StriCmp(TokenList[0], L"selection_big") == 0) {
-            HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionBigFileName));
+           HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionBigFileName));
 
         } else if (StriCmp(TokenList[0], L"default_selection") == 0) {
-            HandleString(TokenList, TokenCount, &(GlobalConfig.DefaultSelection));
-            
+           HandleString(TokenList, TokenCount, &(GlobalConfig.DefaultSelection));
+
         } else if (StriCmp(TokenList[0], L"textonly") == 0) {
             GlobalConfig.TextOnly = TRUE;
 
-        } else if ((StriCmp(TokenList[0], L"}") == 0) || (StriCmp(TokenList[0], L"loader") == 0) ||
-                   (StriCmp(TokenList[0], L"icon") == 0) || (StriCmp(TokenList[0], L"options") == 0)) {
-           // Do nothing; handled by ScanUserConfigured()
-        } else if ((StriCmp(TokenList[0], L"max_tags") == 0) && (TokenCount > 1)) {
-           GlobalConfig.MaxTags = Atoi(TokenList[1]);
+        } else if ((StriCmp(TokenList[0], L"resolution") == 0) && (TokenCount == 3)) {
+           GlobalConfig.RequestedScreenWidth = Atoi(TokenList[1]);
+           GlobalConfig.RequestedScreenHeight = Atoi(TokenList[2]);
+
+        } else if (StriCmp(TokenList[0], L"use_graphics_for") == 0) {
+           GlobalConfig.GraphicsFor = 0;
+           for (i = 1; i < TokenCount; i++) {
+              if (StriCmp(TokenList[i], L"osx")) {
+                 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_OSX;
+              } else if (StriCmp(TokenList[i], L"linux")) {
+                 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_LINUX;
+              } else if (StriCmp(TokenList[i], L"elilo")) {
+                 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_ELILO;
+              } else if (StriCmp(TokenList[i], L"grub")) {
+                 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_GRUB;
+              } else if (StriCmp(TokenList[i], L"windows")) {
+                 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_WINDOWS;
+              }
+           } // for (graphics_on tokens)
+
+        } else if (StriCmp(TokenList[0], L"scan_all_linux_kernels") == 0) {
+           GlobalConfig.ScanAllLinux = TRUE;
+
+        } else if (StriCmp(TokenList[0], L"max_tags") == 0) {
+           HandleInt(TokenList, TokenCount, &(GlobalConfig.MaxTags));
         }
 
         FreeTokenLine(&TokenList, &TokenCount);
@@ -419,13 +447,15 @@ static VOID AddSubmenu(LOADER_ENTRY *Entry, REFIT_FILE *File, REFIT_VOLUME *Volu
    if ((SubEntry == NULL) || (SubScreen == NULL))
       return;
    SubEntry->me.Title        = StrDuplicate(Title);
-   
+
    while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
+
       if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
          if (SubEntry->LoaderPath != NULL)
             FreePool(SubEntry->LoaderPath);
          SubEntry->LoaderPath = StrDuplicate(TokenList[1]);
          SubEntry->DevicePath = FileDevicePath(Volume->DeviceHandle, SubEntry->LoaderPath);
+
       } else if (StriCmp(TokenList[0], L"initrd") == 0) {
          if (SubEntry->InitrdPath != NULL)
             FreePool(SubEntry->InitrdPath);
@@ -433,6 +463,7 @@ static VOID AddSubmenu(LOADER_ENTRY *Entry, REFIT_FILE *File, REFIT_VOLUME *Volu
          if (TokenCount > 1) {
             SubEntry->InitrdPath = StrDuplicate(TokenList[1]);
          }
+
       } else if (StriCmp(TokenList[0], L"options") == 0) {
          if (SubEntry->LoadOptions != NULL)
             FreePool(SubEntry->LoadOptions);
@@ -440,15 +471,20 @@ static VOID AddSubmenu(LOADER_ENTRY *Entry, REFIT_FILE *File, REFIT_VOLUME *Volu
          if (TokenCount > 1) {
             SubEntry->LoadOptions = StrDuplicate(TokenList[1]);
          } // if/else
+
       } else if ((StriCmp(TokenList[0], L"add_options") == 0) && (TokenCount > 1)) {
          MergeStrings(&SubEntry->LoadOptions, TokenList[1], L' ');
+
       } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
          SubEntry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
+
       } else if (StriCmp(TokenList[0], L"disabled") == 0) {
          SubEntry->Enabled = FALSE;
       } // ief/elseif
+
       FreeTokenLine(&TokenList, &TokenCount);
    } // while()
+
    if (SubEntry->InitrdPath != NULL) {
       MergeStrings(&SubEntry->LoadOptions, L"initrd=", L' ');
       MergeStrings(&SubEntry->LoadOptions, SubEntry->InitrdPath, 0);
@@ -461,7 +497,40 @@ static VOID AddSubmenu(LOADER_ENTRY *Entry, REFIT_FILE *File, REFIT_VOLUME *Volu
    Entry->me.SubScreen = SubScreen;
 } // VOID AddSubmenu()
 
-// Adds the options from a SINGLE loaders.conf stanza to a new loader entry and returns
+// Finds a volume with the specified Identifier (a volume label or a number
+// followed by a colon, for the moment). If found, sets *Volume to point to
+// that volume. If not, leaves it unchanged.
+// Returns TRUE if a match was found, FALSE if not.
+static BOOLEAN FindVolume(REFIT_VOLUME **Volume, CHAR16 *Identifier) {
+   UINTN     i = 0, CountedVolumes = 0;
+   INTN      Number = -1;
+   BOOLEAN   Found = FALSE;
+
+   if ((StrLen(Identifier) >= 2) && (Identifier[StrLen(Identifier) - 1] == L':') &&
+       (Identifier[0] >= L'0') && (Identifier[0] <= L'9')) {
+      Number = (INTN) Atoi(Identifier);
+   }
+   while ((i < VolumesCount) && (!Found)) {
+      if (Number >= 0) { // User specified a volume by number
+         if (Volumes[i]->IsReadable) {
+            if (CountedVolumes == Number) {
+               *Volume = Volumes[i];
+               Found = TRUE;
+            }
+            CountedVolumes++;
+         } // if
+      } else { // User specified a volume by label
+         if (StriCmp(Identifier, Volumes[i]->VolName) == 0) {
+            *Volume = Volumes[i];
+            Found = TRUE;
+         } // if
+      } // if/else
+      i++;
+   } // while()
+   return (Found);
+} // static VOID FindVolume()
+
+// Adds the options from a SINGLE refind.conf stanza to a new loader entry and returns
 // that entry. The calling function is then responsible for adding the entry to the
 // list of entries.
 static LOADER_ENTRY * AddStanzaEntries(REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
@@ -469,6 +538,7 @@ static LOADER_ENTRY * AddStanzaEntries(REFIT_FILE *File, REFIT_VOLUME *Volume, C
    UINTN        TokenCount;
    LOADER_ENTRY *Entry;
    BOOLEAN      DefaultsSet = FALSE, AddedSubmenu = FALSE;
+   REFIT_VOLUME *CurrentVolume = Volume;
 
    // prepare the menu entry
    Entry = InitializeLoaderEntry(NULL);
@@ -476,24 +546,33 @@ static LOADER_ENTRY * AddStanzaEntries(REFIT_FILE *File, REFIT_VOLUME *Volume, C
       return NULL;
 
    Entry->Title           = StrDuplicate(Title);
-   Entry->me.Title        = PoolPrint(L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", Volume->VolName);
+   Entry->me.Title        = AllocateZeroPool(256 * sizeof(CHAR16));
+   SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
    Entry->me.Row          = 0;
-   Entry->me.BadgeImage   = Volume->VolBadgeImage;
-   Entry->VolName         = Volume->VolName;
+   Entry->me.BadgeImage   = CurrentVolume->VolBadgeImage;
+   Entry->VolName         = CurrentVolume->VolName;
 
    // Parse the config file to add options for a single stanza, terminating when the token
    // is "}" or when the end of file is reached.
    while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
       if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
          Entry->LoaderPath = StrDuplicate(TokenList[1]);
-         Entry->DevicePath = FileDevicePath(Volume->DeviceHandle, Entry->LoaderPath);
-         SetLoaderDefaults(Entry, TokenList[1], Volume);
+         Entry->DevicePath = FileDevicePath(CurrentVolume->DeviceHandle, Entry->LoaderPath);
+         SetLoaderDefaults(Entry, TokenList[1], CurrentVolume);
          FreePool(Entry->LoadOptions);
          Entry->LoadOptions = NULL; // Discard default options, if any
          DefaultsSet = TRUE;
+      } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
+         if (FindVolume(&CurrentVolume, TokenList[1])) {
+            FreePool(Entry->me.Title);
+            Entry->me.Title        = AllocateZeroPool(256 * sizeof(CHAR16));
+            SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
+            Entry->me.BadgeImage   = CurrentVolume->VolBadgeImage;
+            Entry->VolName         = CurrentVolume->VolName;
+         } // if match found
       } else if ((StriCmp(TokenList[0], L"icon") == 0) && (TokenCount > 1)) {
          FreePool(Entry->me.Image);
-         Entry->me.Image = LoadIcns(Volume->RootDir, TokenList[1], 128);
+         Entry->me.Image = LoadIcns(CurrentVolume->RootDir, TokenList[1], 128);
          if (Entry->me.Image == NULL) {
             Entry->me.Image = DummyImage(128);
          }
@@ -514,7 +593,7 @@ static LOADER_ENTRY * AddStanzaEntries(REFIT_FILE *File, REFIT_VOLUME *Volume, C
       } else if (StriCmp(TokenList[0], L"disabled") == 0) {
          Entry->Enabled = FALSE;
       } else if ((StriCmp(TokenList[0], L"submenuentry") == 0) && (TokenCount > 1)) {
-         AddSubmenu(Entry, File, Volume, TokenList[1]);
+         AddSubmenu(Entry, File, CurrentVolume, TokenList[1]);
          AddedSubmenu = TRUE;
       } // set options to pass to the loader program
       FreeTokenLine(&TokenList, &TokenCount);
@@ -531,12 +610,12 @@ static LOADER_ENTRY * AddStanzaEntries(REFIT_FILE *File, REFIT_VOLUME *Volume, C
    } // if
 
    if (!DefaultsSet)
-      SetLoaderDefaults(Entry, L"\\EFI\\BOOT\\nemo.efi", Volume); // user included no entry; use bogus one
+      SetLoaderDefaults(Entry, L"\\EFI\\BOOT\\nemo.efi", CurrentVolume); // user included no entry; use bogus one
 
    return(Entry);
 } // static VOID AddStanzaEntries()
 
-// Read the user-configured loaders file, loaders.conf, and add or delete
+// Read the user-configured loaders file, refind_loaders.conf, and add or delete
 // entries based on the contents of that file....
 VOID ScanUserConfigured(VOID)
 {
@@ -554,7 +633,6 @@ VOID ScanUserConfigured(VOID)
          return;
 
       Volume = SelfVolume;
-      // TODO: Figure out how to set volumes (on per-image basis, preferably)
 
       while ((TokenCount = ReadTokenLine(&File, &TokenList)) > 0) {
          if ((StriCmp(TokenList[0], L"menuentry") == 0) && (TokenCount > 1)) {