rom/devs/ahci/ahci_busclass.c

   1 /*
   2     Copyright © 2018, The AROS Development Team. All rights reserved.
   3     $Id$
   4 */
   5
   6 #include <aros/debug.h>
   7
   8 #include <proto/exec.h>
   9
  10 /* We want all other bases obtained from our base */
  11 #define __NOLIBBASE__
  12
  13 #include <proto/oop.h>
  14 #include <proto/utility.h>
  15
  16 #include <hidd/storage.h>
  17 #include <hidd/ahci.h>
  18 #include <hidd/hidd.h>
  19 #include <oop/oop.h>
  20 #include <utility/tagitem.h>
  21
  22 #include "ahci.h"
  23
  24 #define DIRQ(x)
  25
  26 #if (0)
  27 static AROS_INTH1(ahciBus_Reset, struct ahci_Bus *, bus)
  28 {
  29     AROS_INTFUNC_INIT
  30
  31     struct AHCIBase *AHCIBase = bus->ab_Base;
  32     OOP_Object *obj = (void *)bus - AHCIBase->busClass->InstOffset;
  33
  34         D(bug ("[AHCI:Bus] ahciBus_Reset(%p)\n", bus);)
  35
  36     HIDD_AHCIBus_Shutdown(obj);
  37
  38     return FALSE;
  39
  40     AROS_INTFUNC_EXIT
  41 }
  42 #endif
  43
  44 /*****************************************************************************************
  45
  46     NAME
  47         --background_busclass--
  48
  49     LOCATION
  50         CLID_Hidd_AHCIBus
  51
  52     NOTES
  53         This class serves as a base class for implementing AHCI SATA bus drivers.
  54
  55 *****************************************************************************************/
  56 /*****************************************************************************************
  57
  58     NAME
  59         aoHidd_AHCIBus_Unit
  60
  61     SYNOPSIS
  62         [..G], OOP_Object *
  63
  64     LOCATION
  65         CLID_Hidd_AHCIBus
  66
  67     FUNCTION
  68         Returns a pointer to OOP object of private unit class, representing
  69         a drive on the bus, or NULL if there's no device.
  70
  71     NOTES
  72
  73     EXAMPLE
  74
  75     BUGS
  76
  77     SEE ALSO
  78
  79     INTERNALS
  80
  81 *****************************************************************************************/
  82
  83 OOP_Object *AHCIBus__Root__New(OOP_Class *cl, OOP_Object *o, struct pRoot_New *msg)
  84 {
  85     struct AHCIBase *AHCIBase = cl->UserData;
  86     struct ahci_port *ap = (struct ahci_port *)GetTagData(aHidd_DriverData, 0, msg->attrList);
  87
  88     D(bug ("[AHCI:Bus] Root__New()\n");)
  89
  90     if (!ap)
  91             return NULL;
  92
  93     o = (OOP_Object *)OOP_DoSuperMethod(cl, o, (OOP_Msg)msg);
  94     if (o)
  95     {
  96         struct ahci_Bus *data = OOP_INST_DATA(cl, o);
  97 #if (0)
  98         struct TagItem *tstate = msg->attrList;
  99         struct TagItem *tag;
 100
 101         while ((tag = NextTagItem(&tstate)))
 102         {
 103             ULONG idx;
 104
 105             Hidd_AHCIBus_Switch(tag->ti_Tag, idx)
 106             {
 107             }
 108         }
 109 #endif
 110         /* Cache device base pointer. Useful. */
 111         data->ab_Base = AHCIBase;
 112         if ((data->ab_Port = ap) != NULL)
 113         {
 114             ap->ap_Object = o;
 115         }
 116         D(
 117           bug ("[AHCI:Bus] Root__New: AHCIBase @ %p\n", data->ab_Base);
 118           bug ("[AHCI:Bus] Root__New: ahci_port @ %p\n", data->ab_Port);
 119         )
 120     }
 121     return o;
 122 }
 123
 124 void AHCIBus__Root__Dispose(OOP_Class *cl, OOP_Object *o, OOP_Msg msg)
 125 {
 126 #if (0)
 127     struct ahci_Bus *data = OOP_INST_DATA(cl, o);
 128 #endif
 129     D(bug ("[AHCI:Bus] Root__Dispose(%p)\n", o);)
 130
 131     OOP_DoSuperMethod(cl, o, msg);
 132 }
 133
 134 /*
 135  * Here we take into account that the table can be either
 136  * terminated early, or have NULL entries.
 137  */
 138 void AHCIBus__Root__Get(OOP_Class *cl, OOP_Object *o, struct pRoot_Get *msg)
 139 {
 140     struct AHCIBase *AHCIBase = cl->UserData;
 141 #if (0)
 142     struct ahci_Bus *data = OOP_INST_DATA(cl, o);
 143 #endif
 144     ULONG idx;
 145
 146     Hidd_Bus_Switch (msg->attrID, idx)
 147     {
 148     case aoHidd_Bus_MaxUnits:
 149         *msg->storage = 1;
 150         return;
 151     }
 152
 153     OOP_DoSuperMethod(cl, o, &msg->mID);
 154 }
 155
 156 void AHCIBus__Hidd_StorageBus__EnumUnits(OOP_Class *cl, OOP_Object *o, struct pHidd_StorageBus_EnumUnits *msg)
 157 {
 158     struct ahci_Bus *data = OOP_INST_DATA(cl, o);
 159
 160     D(bug ("[AHCI:Bus] Hidd_StorageBus__EnumUnits()\n");)
 161
 162     if (data->ab_Unit)
 163     {
 164         CALLHOOKPKT(msg->callback, data->ab_Unit, msg->hookMsg);
 165     }
 166 }
 167
 168 /*****************************************************************************************
 169
 170     NAME
 171         moHidd_AHCIBus_Shutdown
 172
 173     SYNOPSIS
 174         APTR OOP_DoMethod(OOP_Object *obj, struct pHidd_AHCIBus_Shutdown *Msg);
 175
 176         APTR HIDD_AHCIBus_Shutdown(void);
 177
 178     LOCATION
 179         CLID_Hidd_AHCIBus
 180
 181     FUNCTION
 182         Instantly shutdown all activity on the bus.
 183
 184     INPUTS
 185         None
 186
 187     RESULT
 188         None
 189
 190     NOTES
 191         This method is called by ahci.device during system reset handler execution.
 192
 193     EXAMPLE
 194
 195     BUGS
 196
 197     SEE ALSO
 198
 199     INTERNALS
 200         Default implementation disables interrupt using AltControl register.
 201
 202 *****************************************************************************************/
 203
 204 void AHCIBus__Hidd_AHCIBus__Shutdown(OOP_Class *cl, OOP_Object *o, OOP_Msg *msg)
 205 {
 206 #if (0)
 207     struct ahci_Bus *data = OOP_INST_DATA(cl, o);
 208 #endif
 209     D(bug ("[AHCI:Bus] AHCIBus__Shutdown(%p)\n", o);)
 210 }
 211
 212 /***************** Private nonvirtual methods follow *****************/
 213
 214 BOOL Hidd_AHCIBus_Start(OOP_Object *o, struct AHCIBase *AHCIBase)
 215 {
 216     D(bug ("[AHCI:Bus] AHCIBus_Start(%p)\n", o);)
 217 #if (0)
 218     struct ahci_Bus *ab = OOP_INST_DATA(AHCIBase->busClass, o);
 219         struct ahci_port *ap = ab->ab_Port;
 220
 221         while (ap->ap_signal & AP_SIGF_INIT)
 222                 ahci_os_sleep(100);
 223         ahci_os_lock_port(ap);
 224         if (ahci_cam_attach(ap) == 0) {
 225                 ahci_cam_changed(ap, NULL, -1);
 226                 ahci_os_unlock_port(ap);
 227                 while ((ap->ap_flags & AP_F_SCAN_COMPLETED) == 0) {
 228                         ahci_os_sleep(100);
 229                 }
 230         } else {
 231                 ahci_os_unlock_port(ap);
 232         }
 233 #endif
 234
 235         return TRUE;
 236 }
 237
 238
 239 AROS_UFH3(BOOL, Hidd_AHCIBus_Open,
 240           AROS_UFHA(struct Hook *, h, A0),
 241           AROS_UFHA(OOP_Object *, obj, A2),
 242           AROS_UFHA(IPTR, reqUnit, A1))
 243 {
 244     AROS_USERFUNC_INIT
 245
 246     D(bug ("[AHCI:Bus] Hidd_AHCIBus_Open(%p)\n", obj);)
 247 #if (0)
 248     struct IORequest *req = h->h_Data;
 249     struct AHCIBase *AHCIBase = (struct AHCIBase *)req->io_Device;
 250     struct ahci_Bus *b = (struct ahci_Bus *)OOP_INST_DATA(AHCIBase->busClass, obj);
 251     ULONG bus = reqUnit >> 1;
 252     UBYTE dev = reqUnit & 1;
 253
 254     D(bug("[ATA%02ld] Checking bus %u dev %u\n", reqUnit, bus, dev));
 255
 256     if ((b->ab_BusNum == bus) && b->ab_Units[dev])
 257     {
 258         /* Got the unit */
 259         req->io_Unit  = &b->ab_Units[dev]->au_Unit;
 260         req->io_Error = 0;
 261
 262         b->ab_Units[dev]->au_Unit.unit_OpenCnt++;
 263         return TRUE;
 264     }
 265 #endif
 266     return FALSE;
 267
 268     AROS_USERFUNC_EXIT
 269 }