rom/devs/ata/unit_class.c

   1 /*
   2     Copyright © 1995-2013, The AROS Development Team. All rights reserved.
   3     $Id$
   4 */
   5
   6 #include <aros/debug.h>
   7 #include <hidd/ata.h>
   8 #include <oop/oop.h>
   9 #include <proto/exec.h>
  10
  11 #include "ata.h"
  12
  13 /*****************************************************************************************
  14
  15     NAME
  16         --background--
  17
  18     LOCATION
  19         IID_Hidd_ATAUnit
  20
  21     NOTES
  22         Unit class is private to ata.device. Instances of this class represent
  23         devices connected to IDE buses, and can be used to obtain information
  24         about these devices.
  25
  26 *****************************************************************************************/
  27
  28 /*
  29  * a STUB function for commands not supported by this particular device
  30  */
  31 static BYTE ata_STUB(struct ata_Unit *au)
  32 {
  33     D(bug("[ATA%02ld] CALLED STUB FUNCTION (GENERIC). THIS OPERATION IS NOT "
  34         "SUPPORTED BY DEVICE\n", au->au_UnitNum));
  35     return CDERR_NOCMD;
  36 }
  37
  38 static BYTE ata_STUB_IO32(struct ata_Unit *au, ULONG blk, ULONG len,
  39     APTR buf, ULONG* act)
  40 {
  41     D(bug("[ATA%02ld] CALLED STUB FUNCTION (IO32). THIS OPERATION IS NOT "
  42         "SUPPORTED BY DEVICE\n", au->au_UnitNum));
  43     return CDERR_NOCMD;
  44 }
  45
  46 static BYTE ata_STUB_IO64(struct ata_Unit *au, UQUAD blk, ULONG len,
  47     APTR buf, ULONG* act)
  48 {
  49     D(bug("[ATA%02ld] CALLED STUB FUNCTION -- IO ACCESS TO BLOCK %08lx:%08lx, LENGTH %08lx. THIS OPERATION IS NOT SUPPORTED BY DEVICE\n", au->au_UnitNum, (blk >> 32), (blk & 0xffffffff), len));
  50     return CDERR_NOCMD;
  51 }
  52
  53 static BYTE ata_STUB_SCSI(struct ata_Unit *au, struct SCSICmd* cmd)
  54 {
  55     D(bug("[ATA%02ld] CALLED STUB FUNCTION. THIS OPERATION IS NOT SUPPORTED BY DEVICE\n", au->au_UnitNum));
  56     return CDERR_NOCMD;
  57 }
  58
  59 OOP_Object *ATAUnit__Root__New(OOP_Class *cl, OOP_Object *o, struct pRoot_New *msg)
  60 {
  61     o = (OOP_Object *)OOP_DoSuperMethod(cl, o, &msg->mID);
  62     if (o)
  63     {
  64         struct ataBase *ATABase = cl->UserData;
  65         struct ata_Unit *unit = OOP_INST_DATA(cl, o);
  66
  67         unit->au_Drive = AllocPooled(ATABase->ata_MemPool, sizeof(struct DriveIdent));
  68         if (!unit->au_Drive)
  69         {
  70             OOP_MethodID disp_msg = msg->mID - moRoot_New + moRoot_Dispose;
  71
  72             OOP_DoSuperMethod(cl, o, &disp_msg);
  73             return NULL;
  74         }
  75
  76         unit->au_SectorShift = 9; /* this really has to be set here. */
  77
  78         NEWLIST(&unit->au_SoftList);
  79
  80         /*
  81          * since the stack is always handled by caller
  82          * it's safe to stub all calls with one function
  83          */
  84         unit->au_Read32     = ata_STUB_IO32;
  85         unit->au_Read64     = ata_STUB_IO64;
  86         unit->au_Write32    = ata_STUB_IO32;
  87         unit->au_Write64    = ata_STUB_IO64;
  88         unit->au_Eject      = ata_STUB;
  89         unit->au_DirectSCSI = ata_STUB_SCSI;
  90         unit->au_Identify   = ata_STUB;
  91     }
  92     return o;
  93 }
  94
  95 void ATAUnit__Root__Dispose(OOP_Class *cl, OOP_Object *o, OOP_Msg msg)
  96 {
  97     struct ataBase *ATABase = cl->UserData;
  98     struct ata_Unit *unit = OOP_INST_DATA(cl, o);
  99
 100     FreePooled(ATABase->ata_MemPool, unit->au_Drive, sizeof(struct DriveIdent));
 101     OOP_DoSuperMethod(cl, o, msg);
 102 }
 103
 104 /*****************************************************************************************
 105
 106     NAME
 107         aoHidd_ATAUnit_Number
 108
 109     SYNOPSIS
 110         [..G], ULONG
 111
 112     LOCATION
 113         IID_Hidd_ATAUnit
 114
 115     FUNCTION
 116         Returns number of ata.device unit corresponding to this device.
 117
 118     NOTES
 119
 120     EXAMPLE
 121
 122     BUGS
 123
 124     SEE ALSO
 125
 126     INTERNALS
 127
 128 *****************************************************************************************/
 129 /*****************************************************************************************
 130
 131     NAME
 132         aoHidd_ATAUnit_Model
 133
 134     SYNOPSIS
 135         [..G], CONST_STRPTR
 136
 137     LOCATION
 138         IID_Hidd_ATAUnit
 139
 140     FUNCTION
 141         Returns model ID string for this device.
 142
 143     NOTES
 144
 145     EXAMPLE
 146
 147     BUGS
 148
 149     SEE ALSO
 150         aoHidd_ATAUnit_Revision, aoHidd_ATAUnit_Serial
 151
 152     INTERNALS
 153
 154 *****************************************************************************************/
 155 /*****************************************************************************************
 156
 157     NAME
 158         aoHidd_ATAUnit_Revision
 159
 160     SYNOPSIS
 161         [..G], CONST_STRPTR
 162
 163     LOCATION
 164         IID_Hidd_ATAUnit
 165
 166     FUNCTION
 167         Returns revision ID string for this device.
 168
 169     NOTES
 170
 171     EXAMPLE
 172
 173     BUGS
 174
 175     SEE ALSO
 176         aoHidd_ATAUnit_Model, aoHidd_ATAUnit_Serial
 177
 178     INTERNALS
 179
 180 *****************************************************************************************/
 181 /*****************************************************************************************
 182
 183     NAME
 184         aoHidd_ATAUnit_Serial
 185
 186     SYNOPSIS
 187         [..G], CONST_STRPTR
 188
 189     LOCATION
 190         IID_Hidd_ATAUnit
 191
 192     FUNCTION
 193         Returns serial number string for this device.
 194
 195     NOTES
 196
 197     EXAMPLE
 198
 199     BUGS
 200
 201     SEE ALSO
 202         aoHidd_ATAUnit_Model, aoHidd_ATAUnit_Revision
 203
 204     INTERNALS
 205
 206 *****************************************************************************************/
 207 /*****************************************************************************************
 208
 209     NAME
 210         aoHidd_ATAUnit_XferModes
 211
 212     SYNOPSIS
 213         [..G], ULONG
 214
 215     LOCATION
 216         IID_Hidd_ATAUnit
 217
 218     FUNCTION
 219         Tells which transfer modes are supported by this device. The returned value
 220         is a bitwise combination of the following flags (see include/hidd/ata.h):
 221
 222         AF_XFER_PIO(x)  - PIO mode number x (0 - 4)
 223         AF_XFER_MDMA(x) - multiword DMA mode number x (0 - 2)
 224         AF_XFER_UDMA(x) - Ultra DMA mode number x (0 - 6)
 225         AF_XFER_48BIT   - LBA48 block addressing
 226         AF_XFER_RWMILTI - Multisector PIO
 227         AF_XFER_PACKET  - ATAPI
 228         AF_XFER_LBA     - LBA28 block addressing
 229         AF_XFER_PIO32   - 32-bit PIO
 230
 231     NOTES
 232
 233     EXAMPLE
 234
 235     BUGS
 236         32-bit PIO is actually controller's property and not drive's property.
 237         Because of this AF_XFER_PIO32 flag can never be returned by this attribute.
 238         Nevertheless, it can be returned by aoHidd_ATAUnit_ConfiguredModes
 239         attribute.
 240
 241     SEE ALSO
 242         aoHidd_ATAUnit_ConfiguredModes
 243
 244     INTERNALS
 245
 246 *****************************************************************************************/
 247 /*****************************************************************************************
 248
 249     NAME
 250         aoHidd_ATAUnit_Removable
 251
 252     SYNOPSIS
 253         [..G], BOOL
 254
 255     LOCATION
 256         IID_Hidd_ATAUnit
 257
 258     FUNCTION
 259         Tells if this drive has removable media.
 260
 261     NOTES
 262
 263     EXAMPLE
 264
 265     BUGS
 266
 267     SEE ALSO
 268
 269     INTERNALS
 270
 271 *****************************************************************************************/
 272 /*****************************************************************************************
 273
 274     NAME
 275         aoHidd_ATAUnit_MultiSector
 276
 277     SYNOPSIS
 278         [..G], UBYTE
 279
 280     LOCATION
 281         IID_Hidd_ATAUnit
 282
 283     FUNCTION
 284         Tells maximum allowed number of sectors for multisector transfer.
 285
 286     NOTES
 287
 288     EXAMPLE
 289
 290     BUGS
 291
 292     SEE ALSO
 293
 294     INTERNALS
 295
 296 *****************************************************************************************/
 297 /*****************************************************************************************
 298
 299     NAME
 300         aoHidd_ATAUnit_ConfiguredModes
 301
 302     SYNOPSIS
 303         [..G], ULONG
 304
 305     LOCATION
 306         IID_Hidd_ATAUnit
 307
 308     FUNCTION
 309         Tells which transfer modes are currently configured for use with the drive.
 310         The returned value is a bitmask of the same flags as for
 311         aoHidd_ATAUnit_XferModes attribute.
 312
 313     NOTES
 314
 315     EXAMPLE
 316
 317     BUGS
 318         Currently ata.device does not distinguish between PIO modes and does not
 319         set any bit for them. Absence of DMA mode flags automatically means that
 320         PIO mode is used.
 321
 322     SEE ALSO
 323         aoHidd_ATAUnit_XferModes
 324
 325     INTERNALS
 326
 327 *****************************************************************************************/
 328
 329 void ATAUnit__Root__Get(OOP_Class *cl, OOP_Object *o, struct pRoot_Get *msg)
 330 {
 331     struct ataBase *ATABase = cl->UserData;
 332     struct ata_Unit *unit = OOP_INST_DATA(cl, o);
 333     ULONG idx;
 334
 335     Hidd_ATAUnit_Switch (msg->attrID, idx)
 336     {
 337     case aoHidd_ATAUnit_Number:
 338         *msg->storage = unit->au_UnitNum;
 339         return;
 340
 341     case aoHidd_ATAUnit_Model:
 342         *msg->storage = (IPTR)unit->au_Model;
 343         return;
 344
 345     case aoHidd_ATAUnit_Revision:
 346         *msg->storage = (IPTR)unit->au_FirmwareRev;
 347         return;
 348
 349     case aoHidd_ATAUnit_Serial:
 350         *msg->storage = (IPTR)unit->au_SerialNumber;
 351         return;
 352
 353     case aoHidd_ATAUnit_XferModes:
 354         *msg->storage = unit->au_XferModes;
 355         return;
 356
 357     case aoHidd_ATAUnit_Removable:
 358         *msg->storage = (unit->au_Flags & AF_Removable) ? TRUE : FALSE;
 359         return;
 360
 361     case aoHidd_ATAUnit_MultiSector:
 362         *msg->storage = unit->au_Drive->id_RWMultipleSize & 0xFF;
 363         return;
 364
 365     case aoHidd_ATAUnit_ConfiguredModes:
 366         *msg->storage = unit->au_UseModes;
 367         return;
 368     }
 369
 370     OOP_DoSuperMethod(cl, o, &msg->mID);
 371 }