Changeset 76 for trunk

Timestamp:

Feb 18, 2011, 10:09:10 PM (14 years ago)

Author:

chris

Message:

• APM support
• Generic IOCTL interface for adapter passthrough commands (ATA and ATAPI)
• Fixes to ATAPI sense data handling
• Cosmetic changes to debug reporting
• Fixed missing interrupt enable flag for PIO transfer completions
• Added command line switch /I to ignore specific adapters

Location:

trunk/src/os2ahci

Files:

• Makefile (modified) (5 diffs)
• ahci.c (modified) (8 diffs)
• ata.h (modified) (1 diff)
• atapi.c (modified) (6 diffs)
• init.asm (modified) (1 diff)
• os2ahci.c (modified) (14 diffs)
• os2ahci.def (modified) (1 diff)
• os2ahci.h (modified) (6 diffs)
• pci.c (modified) (2 diffs)
• test (added)
• test/Makefile (added)
• test/ioctl_test.c (added)
• version.h (modified) (1 diff)

trunk/src/os2ahci/Makefile

@@ -50 +50 @@
                -I$(DDK)\base\ibmh \
                -I$(DDK)\base\src\dev\dasd\diskh \
+               -I$(DDK)\base\src\dev\thinkpad\dockii\apmcalls \
                -I$(CC16)\include
 
@@ -57 +58 @@
 LIB_DIRS     = $(DDK)\base\lib\ \
                $(DDK)\base\src\dev\dasd\devhlp\ \
-               $(CC16)\lib\ \
+               $(DDK)\base\src\dev\thinkpad\dockii\apmcalls\ \
+               $(CC16)\lib\ \ 
 
 
@@ -65 +67 @@
 TARGET   = os2ahci.add
 
-LIBS     = addcalls dhcalls doscalls slibcep rmcalls
+LIBS     = addcalls dhcalls doscalls slibcep rmcalls apmcalls
 
-SRCS     = init.asm libc.c os2ahci.c pci.c ahci.c ata.c atapi.c ctxhook.c
+SRCS     = init.asm libc.c os2ahci.c pci.c ahci.c ata.c atapi.c ctxhook.c \
+           apm.c ioctl.c
 
 OBJS     = init.obj libc.obj os2ahci.obj pci.obj ahci.obj ata.obj atapi.obj \
-           ctxhook.obj
+           ctxhook.obj apm.obj ioctl.obj
 
 INCS     = os2ahci.h ahci.h version.h
@@ -88 +91 @@
 libc.obj:     libc.c     Makefile $(INCS)
 
-os2ahci.obj:  os2ahci.c  Makefile $(INCS) bldday.h
+os2ahci.obj:  os2ahci.c  Makefile $(INCS) bldday.h ioctl.h
 
 pci.obj:      pci.c      Makefile $(INCS)
@@ -99 +102 @@
 
 ctxhook.obj:  ctxhook.c  Makefile $(INCS) ata.h atapi.h
+
+apm.obj:      apm.c      Makefile $(INCS)
+
+ioctl.obj:    ioctl.c    Makefile $(INCS) atapi.h ioctl.h
 
 ###############################################################################

trunk/src/os2ahci/ahci.c

@@ -591 +591 @@
 
   dprintf("resetting port %d.%d\n", ad_no(ai), p);
+  ddprintf(" PORT_CMD_ISSUE = 0x%lx\n", readl(port_mmio + PORT_CMD_ISSUE));
+  ddprintf(" PORT_SCR_ACT   = 0x%lx\n", readl(port_mmio + PORT_SCR_ACT));
+  ddprintf(" PORT_SCR_ERR   = 0x%lx\n", readl(port_mmio + PORT_SCR_ERR));
+  ddprintf(" PORT_TFDATA    = 0x%lx\n", readl(port_mmio + PORT_TFDATA));
+  ddprintf(" PORT_IRQ_STAT  = 0x%lx\n", readl(port_mmio + PORT_IRQ_STAT));
+  ddprintf(" PORT_IRQ_MASK  = 0x%lx\n", readl(port_mmio + PORT_IRQ_MASK));
+  ddprintf(" HOST_IRQ_STAT  = 0x%lx\n", readl(ai->mmio + HOST_IRQ_STAT));
 
   /* stop port engines (we don't care whether there is an error doing so) */
@@ -597 +604 @@
   /* clear SError */
   tmp = readl(port_mmio + PORT_SCR_ERR);
-  ddprintf(" PORT_SCR_ERR  = 0x%lx\n", tmp);
   writel(port_mmio + PORT_SCR_ERR, tmp);
 
   /* clear pending port IRQs */
   tmp = readl(port_mmio + PORT_IRQ_STAT);
-  ddprintf("PORT_IRQ_STAT was 0x%lx\n", tmp);
   if (tmp) {
     writel(port_mmio + PORT_IRQ_STAT, tmp);
   }
-  ddprintf(" PORT_IRQ_STAT = 0x%lx\n", tmp);
-  ddprintf(" PORT_IRQ_MASK = 0x%lx\n", readl(port_mmio + PORT_IRQ_MASK));
-  ddprintf(" HOST_IRQ_STAT = 0x%lx\n", readl(ai->mmio + HOST_IRQ_STAT));
   writel(ai->mmio + HOST_IRQ_STAT, 1UL << p);
 
@@ -701 +703 @@
                                       PORT_IRQ_UNK_FIS |
                                       PORT_IRQ_SDB_FIS |
+                                      PORT_IRQ_DMAS_FIS |
+                                      PORT_IRQ_PIOS_FIS |
                                       PORT_IRQ_D2H_REG_FIS);
   } else {
@@ -759 +763 @@
 
   /* disable port interrupts */
-  writel(port_mmio + PORT_IRQ_MASK, PORT_IRQ_TF_ERR);
+  writel(port_mmio + PORT_IRQ_MASK, 0);
 
   /* disable FIS reception */
@@ -839 +843 @@
 
   return((timeout <= 0) ? -1 : 0);
+}
+
+/******************************************************************************
+ * Determine whether a port is busy executing commands.
+ */
+ahci_port_busy(AD_INFO *ai, int p)
+{
+  u8 _far *port_mmio = port_base(ai, p);
+
+  return(readl(port_mmio + PORT_SCR_ACT) != 0 ||
+         readl(port_mmio + PORT_CMD_ISSUE) != 0);
 }
 
@@ -931 +946 @@
         ADD_StartTimerMS(&aws->timer, timeout, (PFN) timeout_callback, iorb, 0);
 
-        /* update IORB */
+        /* issue command to hardware */
+        *cmds |= (1UL << port->cmd_slot);
         aws->queued_hw = 1;
         aws->cmd_slot = port->cmd_slot;
 
-        /* issue command to hardware */
         ddprintf("issuing command on slot %d\n", port->cmd_slot);
-        *cmds |= (1UL << port->cmd_slot);
         if (aws->is_ncq) {
           writel(port_mmio + PORT_SCR_ACT, (1UL << port->cmd_slot));
@@ -1423 +1437 @@
 
 /******************************************************************************
- * Execute ATA command.
+ * Execute ATA command. Please note that this is allowed for both ATA and
+ * ATAPI devices because ATAPI devices will process some ATA commands as well.
  */
 void ahci_execute_ata(IORBH _far *iorb)
@@ -1433 +1448 @@
   dphex(((IORB_ADAPTER_PASSTHRU _far *) iorb)->pControllerCmd,
         ((IORB_ADAPTER_PASSTHRU _far *) iorb)->ControllerCmdLen,
-        "ahci_execute_cdb(%d.%d.%d): ", a, p, d);
-
-  if (ad_infos[a].ports[p].devs[d].atapi) {
-    iorb_seterr(iorb, IOERR_CMD_NOT_SUPPORTED);
-    iorb_done(iorb);
-  } else {
-    ahci_exec_iorb(iorb, 0, ata_execute_ata);
-  }
+        "ahci_execute_ata(%d.%d.%d): ", a, p, d);
+
+  ahci_exec_iorb(iorb, 0, ata_execute_ata);
 }
 

trunk/src/os2ahci/ata.h

@@ -424 +424 @@
 
 /******************************************************************************
- * Generic ATA-8 command structure. This is based on ATA-8, i.e. we won't have
- * to deal with different command structures depending on whether a device is
- * 48-bit capable, etc. because this is handled by the transport (AHCI in our
- * case). Unsupported bits have to be cleared to zero, of course (e.g. the
- * high 20 bits of the LBA when talking to a device that supports only 28
- * bits).
+ * Generic ATA-8 command structure. This is loosely based on ATA-8, i.e. we
+ * don't have to deal with shadow registers and map them to the low bytes of
+ * adjecent words, etc. but there are still some oddities which need to be
+ * taken into consideration. For example, ATA-8 says LBA-28 sector addresses
+ * are simply the lower 28 bits in the LBA field. However, the underlying
+ * transport (SATA in our case) only looks at the three lower bytes of the
+ * LBA field, much like an IDE device would do. This means that only 3 bytes
+ * of the LBA field are processed and this yields only 24 bits. The remaining
+ * 4 bits need to be stored in the "device" register....
+ *
+ * Everything else seems to behave normally, as far as this term can be
+ * applied to IDE/ATA. Further details can be found in section 7.1.5.1 of the
+ * ATA-8 spec (Inputs for 28-bit Read/Write Commands).
  */
 typedef struct {

trunk/src/os2ahci/atapi.c

@@ -168 +168 @@
    * mechanism:" -- Storage Device Driver Reference, Scatter/Gather Lists
    */
-  rc = ata_cmd(ad_infos + iorb_unit_adapter(iorb),
-               iorb_unit_port(iorb),
-               iorb_unit_device(iorb),
-               slot, ATA_CMD_PACKET,
+  rc = ata_cmd(ad_infos + iorb_unit_adapter(iorb), iorb_unit_port(iorb),
+               iorb_unit_device(iorb), slot, ATA_CMD_PACKET,
                AP_ATAPI_CMD, (void _far *) cdb, cdb_len,
                AP_SGLIST, pt->pSGList, pt->cSGList,
@@ -280 +278 @@
     if (ssb->SenseData != NULL) {
       memcpy(ssb->SenseData, psd, max(ssb->ReqSenseLen, ATAPI_SENSE_LEN));
-      ssb->Flags != STATUS_SENSEDATA_VALID;
+      ssb->Flags |= STATUS_SENSEDATA_VALID;
     }
+    iorb->Status |= IORB_STATUSBLOCK_AVAIL;
   }
 
@@ -333 +332 @@
 
 /******************************************************************************
- * pad atapi commands; AHCI requires ATAPI commands to be either 12 or
+ * Pad ATAPI commands; AHCI requires ATAPI commands to be either 12 or
  * 16 bytes in length. This func converts commands that have a 12 byte
  * equivalent, and pads the others to 12 bytes.
@@ -343 +342 @@
 {
   ATAPI_CDB_12 _far *p12;
+  u32 tmp;
 
   if (cmd_in_len == ATAPI_MIN_CDB_LEN || cmd_in_len == ATAPI_MAX_CDB_LEN) {
@@ -364 +364 @@
     p12->cmd = 0xa0 | (cmd_in[0] & 0x0f);
     p12->flags = cmd_in[1] & 0xc0; /* 6byte cmds have no flags (FUA etc.) */
-    SET_CDB_32(p12->lba, (u32) cmd_in[3] | (u32) cmd_in[2] << 8 | 
-                         (u32) (cmd_in[1] & 0x1f) << 16);
-    SET_CDB_32(p12->trans_len, (u32) cmd_in[4]);
+    tmp = GET_CDB_24(cmd_in + 1) & 0x1fffffUL;
+    SET_CDB_32(p12->lba, tmp);
+    SET_CDB_32(p12->trans_len, cmd_in[4]);
     p12->control = cmd_in[5];
     break;
@@ -375 +375 @@
     p12->cmd = 0xa0 | (cmd_in[0] & 0x0f);
     p12->flags = cmd_in[1];
+    p12->control = cmd_in[9];
     memcpy(p12->lba, cmd_in + 2, 4);
-    SET_CDB_32(p12->trans_len, (u32) GET_CDB_16(cmd_in + 7));
-    p12->control = cmd_in[9];
+    tmp = GET_CDB_16(cmd_in + 7);
+    SET_CDB_32(p12->trans_len, tmp);
     break;
 

trunk/src/os2ahci/init.asm

@@ -20 +20 @@
                 PUBLIC  __U4M                ; 32bit unsigned multiply routine
                 PUBLIC  __U4D                ; 32bit unsigned divide routine
-                PUBLIC  __I4D                ; 32bit signed multiply routine
+                PUBLIC  __I4D                ; 32bit signed divide routine
                 PUBLIC  _end_of_data         ; end of all data (label)
                 PUBLIC  _end_of_code         ; end of all code (label)

trunk/src/os2ahci/os2ahci.c

@@ -22 +22 @@
 #include "os2ahci.h"
 #include "bldday.h"
+
+#include "ioctl.h"
 
 /* -------------------------- macros and constants ------------------------- */
@@ -78 +80 @@
 AD_INFO         ad_infos[MAX_AD];  /* adapter information list */
 int             ad_info_cnt;       /* number of entries in ad_infos[] */
+u16             ad_ignore;         /* bitmap with adapter indexes to ignore */
 int             init_complete;     /* if != 0, initialization has completed */
 
@@ -109 +112 @@
   case CMDShutdown:
     rc = exit_drv(((RPSAVERESTORE _far *) req)->FuncCode);
+    break;
+
+  case CMDGenIOCTL:
+    rc = gen_ioctl((RP_GENIOCTL _far *) req);
     break;
 
@@ -174 +181 @@
         break;
 
-      case 'i':
+      case 'g':
         /* add specfied PCI ID as a supported generic AHCI adapter  */
         drv_parm_int(s, vendor, u16, 16);
@@ -193 +200 @@
         /* reset ports during initialization */
         init_reset = 1;
+        break;
+
+      case 'i':
+        /* ignore current adapter index */
+        if (adapter_index >= 0) {
+          ad_ignore |= 1U << adapter_index;
+        }
         break;
 
@@ -291 +305 @@
 
 /******************************************************************************
+ * Generic IOCTL via character device driver. IOCTLs are used to control the
+ * driver operation and to execute native ATA and ATAPI (SCSI) commands from
+ * ring 3 applications.
+ */
+USHORT gen_ioctl(RP_GENIOCTL _far *ioctl)
+{
+  switch (ioctl->Category) {
+
+  case OS2AHCI_IOCTL_CATEGORY:
+
+    switch (ioctl->Function) {
+
+    case OS2AHCI_IOCTL_GET_DEVLIST:
+      return(ioctl_get_devlist(ioctl));
+   
+    case OS2AHCI_IOCTL_PASSTHROUGH:
+      return(ioctl_passthrough(ioctl));
+
+    }
+  }
+  return(STDON | STATUS_ERR_UNKCMD);
+}
+
+/******************************************************************************
  * Device driver exit handler. This handler is called when OS/2 shuts down and
- * flushes the write caches of all attached devices.
+ * flushes the write caches of all attached devices. Since this is effectively
+ * the same we do when suspending, we'll call out to the corresponding APM
+ * function.
  *
  * NOTE: Errors are ignored because there's no way we could stop the shutdown
@@ -300 +340 @@
 USHORT exit_drv(int func)
 {
-  int a;
-  int p;
-  int d;
-
   dprintf("exit_drv(%d) called\n", func);
 
@@ -311 +347 @@
   }
 
-  for (a = 0; a < ad_info_cnt; a++) {
-    AD_INFO *ai = ad_infos + a;
-
-    for (p = 0; p <= ai->port_max; p++) {
-      for (d = 0; d <= ai->ports[p].dev_max; d++) {
-        if (ai->ports[p].devs[d].present) {
-          ahci_flush_cache(ai, p, d);
-        }
-      }
-    }
-  }
-
+  apm_suspend();
   return(STDON);
 }
@@ -575 +600 @@
     if (!init_complete) {
       dprintf("leaving initialization mode\n");
-      spin_lock(drv_lock);
       for (a = 0; a < ad_info_cnt; a++) {
+        lock_adapter(ad_infos + a);
         ahci_complete_init(ad_infos + a);
       }
       init_complete = 1;
-      spin_unlock(drv_lock);
+
+      /* release all adapters */
+      for (a = 0; a < ad_info_cnt; a++) {
+        unlock_adapter(ad_infos + a);
+      }
+
+      /* register APM hook */
+      apm_init();
     }
     iorb_done(iorb);
@@ -941 +973 @@
 
 /******************************************************************************
- * Add an IORB to the specified queue.
+ * Add an IORB to the specified queue. This function must be called with the
+ * adapter-level spinlock aquired.
  */
 void iorb_queue_add(IORB_QUEUE _far *queue, IORBH _far *iorb)
@@ -994 +1027 @@
 
 /******************************************************************************
- * Remove an IORB from the specified queue.
+ * Remove an IORB from the specified queue. This function must be called with
+ * the adapter-level spinlock aquired.
  */
 int iorb_queue_del(IORB_QUEUE _far *queue, IORBH _far *iorb)
@@ -1037 +1071 @@
 {
   iorb->ErrorCode = error_code;
-  iorb->Status = IORB_ERROR;
+  iorb->Status |= IORB_ERROR;
 }
 
@@ -1078 +1112 @@
  * Requeue the specified IORB such that it will be sent downstream for
  * processing again. This includes freeing all resources currently allocated
- * (timer, buffer, ...) and resetting the flags to 0.
+ * (timer, buffer, ...) and resetting the flags to 0. The driver-level
+ * spinlock must be aquired when calling this function.
  *
  * The following flags are preserved:
@@ -1091 +1126 @@
   memset(aws, 0x00, sizeof(*aws));
   aws->no_ncq = no_ncq;
+}
+
+/******************************************************************************
+ * Lock the adapter, waiting for availability if necessary. This is expected
+ * to be called without the driver-level spinlock aquired.
+ */
+void lock_adapter(AD_INFO *ai)
+{
+  spin_lock(drv_lock);
+  while (ai->busy) {
+    spin_unlock(drv_lock);
+    msleep(250);
+    spin_lock(drv_lock);
+  }
+  ai->busy = 1;
+  spin_unlock(drv_lock);
+}
+
+/******************************************************************************
+ * Unlock adapter (i.e. reset busy flag)
+ */
+void unlock_adapter(AD_INFO *ai)
+{
+  ai->busy = 0;
 }
 

trunk/src/os2ahci/os2ahci.def

@@ -1 +1 @@
 library os2ahci
-Description '$@#thi.guten (www.thiguten.de):1.00.20110216#@OS/2 AHCI Adapter Device Driver'
+Description '$@#thi.guten (www.thiguten.de):1.00.20110218#@OS/2 AHCI Adapter Device Driver'
 protmode
 

trunk/src/os2ahci/os2ahci.h

@@ -122 +122 @@
 /* SMP spinlock compatibility macros for older DDKs using CLI/STI */
 #ifndef OS2AHCI_SMP
-#define DevHelp_CreateSpinLock(sph)    *(sph) = 0
+#define DevHelp_CreateSpinLock(p_sph)  *(p_sph) = 0
 #define DevHelp_FreeSpinLock(sph)      0
 
@@ -379 +379 @@
 /* os2ahci.c */
 extern USHORT  init_drv               (RPINITIN _far *req);
+extern USHORT  gen_ioctl              (RP_GENIOCTL _far *ioctl);
 extern USHORT  exit_drv               (int func);
 extern void _cdecl _far _loadds add_entry    (IORBH _far *iorb);
@@ -397 +398 @@
 extern void    iorb_done              (IORBH _far *iorb);
 extern void    iorb_requeue           (IORBH _far *iorb);
+extern void    lock_adapter           (AD_INFO *ai);
+extern void    unlock_adapter         (AD_INFO *ai);
 extern void _cdecl _far timeout_callback    (ULONG timer_handle, ULONG p1, ULONG p2);
 
@@ -416 +419 @@
 extern int     ahci_stop_fis_rx             (AD_INFO *ai, int p);
 extern int     ahci_stop_engine             (AD_INFO *ai, int p);
+extern int     ahci_port_busy               (AD_INFO *ai, int p);
 extern void    ahci_exec_iorb               (IORBH _far *iorb, int ncq_capable,
                                              int (*func)(IORBH _far *, int));
@@ -474 +478 @@
 extern void _cdecl engine_ctxhook     (ULONG parm);
 
+/* apm.c */
+extern void        apm_init           (void);
+extern void        apm_suspend        (void);
+extern void        apm_resume         (void);
+
+/* ioctl.c */
+extern USHORT      ioctl_get_devlist  (RP_GENIOCTL _far *ioctl);
+extern USHORT      ioctl_passthrough  (RP_GENIOCTL _far *ioctl);
+
 /* ---------------------------- global variables --------------------------- */
 
@@ -492 +505 @@
 extern AD_INFO       ad_infos[];    /* adapter information list */
 extern int           ad_info_cnt;   /* number of entries in ad_infos[] */
+extern u16           ad_ignore;     /* bitmap with adapters to be ignored */
 extern int           init_complete; /* if != 0, initialization has completed */
 

trunk/src/os2ahci/pci.c

@@ -409 +409 @@
   UCHAR index;
   UCHAR rc;
+  int ad_indx = 0;
   int i;
 
@@ -460 +461 @@
       if (rc == OH_SUCCESS) {
         /* found a device */
+        if (ad_ignore & (1U << ad_indx++)) {
+          /* ignore this adapter */
+          continue;
+        }
         add_pci_device(pci_ids + i, &data);
         if (++index > 180) {

trunk/src/os2ahci/version.h

@@ -6 +6 @@
 
 
-#define VERSION            102       /* driver version (2 implied decimals) */
+#define VERSION            103       /* driver version (2 implied decimals) */
 
 /* BLDLEVEL information (in C source modules added via macro