rom/expansion/addbootnode.c

   1 /*
   2     Copyright © 1995-2011, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Add a bootable device into the system.
   6     Lang: english
   7 */
   8
   9 #define DEBUG 0
  10 #include <aros/debug.h>
  11
  12 #include <exec/memory.h>
  13 #include <exec/execbase.h>
  14 #include <dos/filehandler.h>
  15
  16 #include <proto/exec.h>
  17 #include <proto/dos.h>
  18
  19 #include "expansion_intern.h"
  20
  21 /*****************************************************************************
  22
  23     NAME */
  24 #include <libraries/configvars.h>
  25 #include <proto/expansion.h>
  26
  27         AROS_LH4(BOOL, AddBootNode,
  28
  29 /*  SYNOPSIS */
  30         AROS_LHA(LONG               , bootPri, D0),
  31         AROS_LHA(ULONG              , flags, D1),
  32         AROS_LHA(struct DeviceNode *, deviceNode, A0),
  33         AROS_LHA(struct ConfigDev  *, configDev, A1),
  34
  35 /*  LOCATION */
  36         struct ExpansionBase *, ExpansionBase, 6, Expansion)
  37
  38 /*  FUNCTION
  39         AddBootNode() will add a device into the system. It does this in
  40         one of two ways:
  41
  42         1. If DOS is running, add the device to DOS's list of devices
  43            immediately.
  44         2. Otherwise, save the information for later use by DOS, possibly
  45            as a boot device.
  46
  47         This allows device drivers to add devices into the system's disk
  48         device list at any time, without having to worry about whether DOS
  49         is available.
  50
  51         If a device is added before DOS is running, then it is possible for
  52         the device to be used as a boot device. This allows for the user
  53         to choose which device he/she wishes to boot from, and even which
  54         OS they may wish to boot from.
  55
  56         The bootstrap will attempt to boot from the highest priority device
  57         on the Expansion eb_BootNode list, and if that fails continue
  58         through the list until it can succeed.
  59
  60         Floppy disk devices should always be given the highest priority, to
  61         allow a user to prevent a hard disk or network boot by inserting a
  62         floppy disk.
  63
  64         AddBootNode() will also perform a second bit of magic, that if there
  65         is no filesystem specified for this device, (i.e. dn_SegList, dn_Task
  66         and dn_Handler are all NULL), then the standard DOS filesystem
  67         will be used for this device.
  68
  69     INPUTS
  70         bootPri     -   a BYTE describing the boot priority for this disk.
  71                         Recommended priorities are:
  72
  73                         +5      -   unit 0 on the floppy disk. The floppy
  74                                     should be the highest priority.
  75                         0       -   standard hard disk priority
  76                         -5      -   recommended for a network disk
  77                         -128    -   don't bother trying
  78
  79         flags       -   Additional information:
  80
  81                         ADNF_STARTPROC (bit 0)-
  82                             if set this will cause AddBootNode() to start
  83                             a filesystem handler for the device node from
  84                             the information contained in the deviceNode
  85                             packet. This bit is only useful when there is
  86                             no running handler for this task (ie dn_Task
  87                             is NULL).
  88
  89         deviceNode  -   DOS device node for this device. Typically created
  90                         by MakeDosNode().
  91
  92         configDev   -   A valid expansion board ConfigDev structure, this
  93                         is required for an autoboot before DOS is running.
  94                         If left NULL, the node cannot be BootPoint booted.
  95
  96     RESULT
  97         TRUE if everything was ok,
  98         FALSE if for some reason we failed (lack of memory etc).
  99
 100     NOTES
 101         The address of the ConfigDev structure is stored in the ln_Name
 102         field of the BootNode structure.
 103
 104     EXAMPLE
 105
 106     BUGS
 107
 108     SEE ALSO
 109         AddDosNode()
 110
 111     INTERNALS
 112
 113     HISTORY
 114
 115 *****************************************************************************/
 116 {
 117     AROS_LIBFUNC_INIT
 118
 119     struct BootNode *bn;
 120     APTR DOSBase;
 121     BOOL ok = FALSE;
 122
 123     if(deviceNode == NULL)
 124         return ok;
 125
 126     D(bug("[AddBootNode] Adding %b from Task %s\n", deviceNode->dn_Name, FindTask(NULL)->tc_Node.ln_Name));
 127
 128     /* See if DOS is up and running... */
 129     DOSBase = OpenLibrary("dos.library", 0);
 130     if (DOSBase == NULL)
 131     {
 132         /* Don't add the same node twice */
 133         ForeachNode(&ExpansionBase->MountList, bn)
 134         {
 135             if (stricmp(AROS_BSTR_ADDR(
 136                 ((struct DeviceNode *) bn->bn_DeviceNode)->dn_Name),
 137                 AROS_BSTR_ADDR(deviceNode->dn_Name)) == 0)
 138             {
 139                 /* so there was already an entry with that DOS name */
 140                 D(bug("[AddBootNode] Rejecting attempt to add duplicate device\n"));
 141                 return FALSE;
 142             }
 143         }
 144
 145         if ((bn = AllocMem(sizeof(struct BootNode), MEMF_CLEAR | MEMF_PUBLIC)))
 146         {
 147             bn->bn_Node.ln_Name = (STRPTR)configDev;
 148             bn->bn_Node.ln_Type = NT_BOOTNODE;
 149             bn->bn_Node.ln_Pri = bootPri;
 150             bn->bn_Flags = flags;
 151             bn->bn_DeviceNode = deviceNode;
 152             D(bug("[AddBootNode] Add BootNode %p to the MountList\n", bn));
 153             Forbid();
 154             Enqueue(&ExpansionBase->MountList, (struct Node *)bn);
 155             Permit();
 156         }
 157         else
 158         {
 159             return FALSE;
 160         }
 161
 162         /* If DOS isn't up yet, that's fine */
 163         ok = TRUE;
 164     }
 165     else
 166     {
 167         /* We should add the filesystem to the DOS device list. It will
 168          * be usable from this point onwards.
 169          *
 170          * The DeviceNode structure that was passed to us can be added
 171          * to the DOS list as it is, and we will let DOS start the
 172          * filesystem task if it is necessary to do so.
 173          */
 174         if (AddDosEntry((struct DosList *)deviceNode))
 175         {
 176             if (!(flags & ADNF_STARTPROC))
 177             {
 178                 ok = TRUE;
 179             }
 180             else
 181             {
 182                 STRPTR dosname;
 183                 BYTE len = AROS_BSTR_strlen(deviceNode->dn_Name);
 184
 185                 /* append a colon to the name, DeviceProc() needs a full path */
 186                 dosname = AllocVec(len + 1 + 1, MEMF_ANY);
 187                 if (dosname)
 188                 {
 189                     CopyMem(AROS_BSTR_ADDR(deviceNode->dn_Name), dosname, len);
 190                     dosname[len++] = ':';
 191                     dosname[len++] = 0;
 192
 193                     /* DeviceProc() will see that dn_Device for this node is NULL
 194                      * and start up the handler.
 195                      */
 196                     D(bug("[AddBootNode] Starting up \"%s\"\n", dosname));
 197                     DeviceProc(dosname);
 198                     FreeVec(dosname);
 199                     ok = TRUE;
 200                 }
 201             }
 202         }
 203
 204         CloseLibrary((struct Library *)DOSBase);
 205     }
 206
 207     return ok;
 208
 209     AROS_LIBFUNC_EXIT
 210 } /* AddBootNode */