Changeset ebb1489 in mainline for uspace/lib/ata/include/ata/ata.h

Timestamp:

2024-10-13T08:23:40Z (2 months ago)

Author:

GitHub <noreply@…>

Children:

0472cf17

Parents:

2a0c827c (diff), b3b79981 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

git-author:

boba-buba <120932204+boba-buba@…> (2024-10-13 08:23:40)

git-committer:

GitHub <noreply@…> (2024-10-13 08:23:40)

Message:

Merge branch 'HelenOS:master' into topic/packet-capture

File:

• uspace/lib/ata/include/ata/ata.h (moved) (moved from uspace/drv/block/ata_bd/ata_bd.h ) (6 diffs)

uspace/lib/ata/include/ata/ata.h

@@ -1 +1 @@
 /*
- * Copyright (c) 2009 Jiri Svoboda
+ * Copyright (c) 2024 Jiri Svoboda
  * All rights reserved.
  *
@@ -27 +27 @@
  */
 
-/** @addtogroup ata_bd
+/** @addtogroup libata
  * @{
  */
-/** @file ATA driver definitions.
- */
-
-#ifndef __ATA_BD_H__
-#define __ATA_BD_H__
+/** @file ATA driver library definitions.
+ */
+
+#ifndef LIBATA_ATA_H
+#define LIBATA_ATA_H
 
 #include <async.h>
 #include <bd_srv.h>
-#include <ddf/driver.h>
 #include <fibril_synch.h>
+#include <stdbool.h>
 #include <str.h>
 #include <stdint.h>
@@ -45 +45 @@
 #include "ata_hw.h"
 
-#define NAME "ata_bd"
-
-/** Base addresses for ATA I/O blocks. */
+struct ata_device;
+
+/** ATA DMA direction */
+typedef enum {
+        /** DMA read */
+        ata_dma_read,
+        /** DMA write */
+        ata_dma_write
+} ata_dma_dir_t;
+
+/** ATA channel creation parameters */
 typedef struct {
-        uintptr_t cmd;  /**< Command block base address. */
-        uintptr_t ctl;  /**< Control block base address. */
-} ata_base_t;
+        /** Argument to callback functions */
+        void *arg;
+        /** IRQ is available */
+        bool have_irq;
+        /** Use DMA transfers */
+        bool use_dma;
+        /** Maximum number of bytes that we can DMA in one I/O operation */
+        size_t max_dma_xfer;
+        /** Read 16 bits from the data port */
+        void (*write_data_16)(void *, uint16_t *, size_t);
+        /** Write 16 bits to the data port */
+        void (*read_data_16)(void *, uint16_t *, size_t);
+        /** Read 8 bits from an 8-bit command register */
+        void (*write_cmd_8)(void *, uint16_t, uint8_t);
+        /** Writes 8 bits to an 8-bit command register */
+        uint8_t (*read_cmd_8)(void *, uint16_t);
+        /** Read 8 bits from a control register */
+        void (*write_ctl_8)(void *, uint16_t, uint8_t);
+        /** Write 8 bits to a control register */
+        uint8_t (*read_ctl_8)(void *, uint16_t);
+        /** Enable interrupts */
+        errno_t (*irq_enable)(void *);
+        /** Disable interrupts */
+        errno_t (*irq_disable)(void *);
+        /** Set up DMA channel */
+        void (*dma_chan_setup)(void *, void *, size_t, ata_dma_dir_t);
+        /** Set up DMA channel */
+        void (*dma_chan_teardown)(void *);
+        /** Add new device */
+        errno_t (*add_device)(void *, unsigned, void *);
+        /** Remove device */
+        errno_t (*remove_device)(void *, unsigned);
+        /** Log notice message */
+        void (*msg_note)(void *, char *);
+        /** Log error message */
+        void (*msg_error)(void *, char *);
+        /** Log warning message */
+        void (*msg_warn)(void *, char *);
+        /** Log debug message */
+        void (*msg_debug)(void *, char *);
+} ata_params_t;
 
 /** Timeout definitions. Unit is 10 ms. */
@@ -99 +145 @@
 
 /** ATA device state structure. */
-typedef struct {
+typedef struct ata_device {
         bool present;
-        struct ata_ctrl *ctrl;
-        struct ata_fun *afun;
+        struct ata_channel *chan;
 
         /** Device type */
@@ -124 +169 @@
         char model[STR_BOUNDS(40) + 1];
 
-        int disk_id;
-} disk_t;
-
-/** ATA controller */
-typedef struct ata_ctrl {
-        /** DDF device */
-        ddf_dev_t *dev;
-        /** I/O base address of the command registers */
-        uintptr_t cmd_physical;
-        /** I/O base address of the control registers */
-        uintptr_t ctl_physical;
+        int device_id;
+        bd_srvs_t bds;
+} ata_device_t;
+
+/** ATA channel */
+typedef struct ata_channel {
+        /** Parameters */
+        ata_params_t params;
 
         /** Command registers */
@@ -141 +183 @@
         ata_ctl_t *ctl;
 
-        /** Per-disk state. */
-        disk_t disk[MAX_DISKS];
-
+        /** Per-device state. */
+        ata_device_t device[MAX_DEVICES];
+
+        /** Synchronize channel access */
         fibril_mutex_t lock;
-} ata_ctrl_t;
-
-typedef struct ata_fun {
-        ddf_fun_t *fun;
-        disk_t *disk;
-        bd_srvs_t bds;
-} ata_fun_t;
-
-extern errno_t ata_ctrl_init(ata_ctrl_t *, ata_base_t *);
-extern errno_t ata_ctrl_remove(ata_ctrl_t *);
-extern errno_t ata_ctrl_gone(ata_ctrl_t *);
-
-extern bd_ops_t ata_bd_ops;
+        /** Synchronize access to irq_fired/irq_status */
+        fibril_mutex_t irq_lock;
+        /** Signalled by IRQ handler */
+        fibril_condvar_t irq_cv;
+        /** Set to true when interrupt occurs */
+        bool irq_fired;
+        /** Value of status register read by interrupt handler */
+        uint8_t irq_status;
+} ata_channel_t;
+
+extern errno_t ata_channel_create(ata_params_t *, ata_channel_t **);
+extern errno_t ata_channel_initialize(ata_channel_t *);
+extern errno_t ata_channel_destroy(ata_channel_t *);
+extern void ata_channel_irq(ata_channel_t *, uint8_t);
+extern void ata_connection(ipc_call_t *, ata_device_t *);
 
 #endif