global: Migrate CONFIG_STACKBASE to CFG
[platform/kernel/u-boot.git] / include / scsi.h
index c764e15..9efefea 100644 (file)
@@ -1,50 +1,62 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
 /*
  * (C) Copyright 2001
  * Denis Peter, MPL AG Switzerland
- *
- * See file CREDITS for list of people who contributed to this
- * project.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of
- * the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
- * MA 02111-1307 USA
- *
  */
  #ifndef _SCSI_H
  #define _SCSI_H
 
-typedef struct SCSI_cmd_block{
-       unsigned char           cmd[16];                                        /* command                                 */
-       /* for request sense */
-       unsigned char           sense_buf[64]
+#include <asm/cache.h>
+#include <linux/dma-direction.h>
+
+/* Fix this to the maximum */
+#define SCSI_MAX_DEVICE \
+       (CONFIG_SYS_SCSI_MAX_SCSI_ID * CONFIG_SYS_SCSI_MAX_LUN)
+
+struct udevice;
+
+/**
+ * struct scsi_cmd - information about a SCSI command to be processed
+ *
+ * @cmd: command
+ * @sense_buf: for request sense
+ * @status: SCSI Status
+ * @target: Target ID
+ * @lun: Target LUN
+ * @cmdlen: command len
+ * @datalen: Total data length
+ * @pdata: pointer to data
+ * @msgout: Messge out buffer (NOT USED)
+ * @msgin: Message in buffer
+ * @sensecmdlen: Sense command len
+ * @sensedatalen: Sense data len
+ * @sensecmd: Sense command
+ * @contr_stat: Controller Status
+ * @trans_bytes: tranfered bytes
+ * @priv: Private value
+ * @dma_dir: Direction of data structure
+ */
+struct scsi_cmd {
+       unsigned char cmd[16];
+       unsigned char sense_buf[64]
                __attribute__((aligned(ARCH_DMA_MINALIGN)));
-       unsigned char           status;                                         /* SCSI Status                   */
-       unsigned char           target;                                         /* Target ID                             */
-       unsigned char           lun;                                                    /* Target LUN        */
-       unsigned char           cmdlen;                                         /* command len                          */
-       unsigned long           datalen;                                        /* Total data length    */
-       unsigned char   *       pdata;                                          /* pointer to data              */
-       unsigned char           msgout[12];                             /* Messge out buffer (NOT USED) */
-       unsigned char           msgin[12];                              /* Message in buffer    */
-       unsigned char           sensecmdlen;                    /* Sense command len    */
-       unsigned long           sensedatalen;                   /* Sense data len                       */
-       unsigned char           sensecmd[6];                    /* Sense command                        */
-       unsigned long           contr_stat;                             /* Controller Status    */
-       unsigned long           trans_bytes;                    /* tranfered bytes              */
-
-       unsigned int            priv;
-}ccb;
+       unsigned char status;
+       unsigned char target;
+       unsigned char lun;
+       unsigned char cmdlen;
+       unsigned long datalen;
+       unsigned char *pdata;
+       unsigned char msgout[12];
+       unsigned char msgin[12];
+       unsigned char sensecmdlen;
+       unsigned long sensedatalen;
+       unsigned char sensecmd[6];
+       unsigned long contr_stat;
+       unsigned long trans_bytes;
+
+       unsigned int priv;
+       enum dma_data_direction dma_dir;
+};
 
 /*-----------------------------------------------------------
 **
@@ -149,6 +161,7 @@ typedef struct SCSI_cmd_block{
 #define SCSI_MED_REMOVL        0x1E            /* Prevent/Allow medium Removal (O) */
 #define SCSI_READ6             0x08            /* Read 6-byte (MANDATORY) */
 #define SCSI_READ10            0x28            /* Read 10-byte (MANDATORY) */
+#define SCSI_READ16    0x48
 #define SCSI_RD_CAPAC  0x25            /* Read Capacity (MANDATORY) */
 #define SCSI_RD_CAPAC10        SCSI_RD_CAPAC   /* Read Capacity (10) */
 #define SCSI_RD_CAPAC16        0x9e            /* Read Capacity (16) */
@@ -174,25 +187,159 @@ typedef struct SCSI_cmd_block{
 #define SCSI_WRITE_LONG        0x3F            /* Write Long (O) */
 #define SCSI_WRITE_SAME        0x41            /* Write Same (O) */
 
+/**
+ * enum scsi_cmd_phase - current phase of the SCSI protocol
+ *
+ * @SCSIPH_START: Start phase
+ * @SCSIPH_DATA: Data phase
+ * @SCSIPH_STATUS: Status phase
+ */
+enum scsi_cmd_phase {
+       SCSIPH_START,
+       SCSIPH_DATA,
+       SCSIPH_STATUS,
+};
 
-/****************************************************************************
- * decleration of functions which have to reside in the LowLevel Part Driver
+/**
+ * struct scsi_inquiry_resp - holds a SCSI inquiry command
+ *
+ * @type; command type
+ * @flags; command flags
+ * @version; command version
+ * @data_format; data format
+ * @additional_len; additional data length
+ * @spare[3]; spare bytes
+ * @vendor[8]; vendor information
+ * @product[16]; production information
+ * @revision[4]; revision information
  */
+struct scsi_inquiry_resp {
+       u8 type;
+       u8 flags;
+       u8 version;
+       u8 data_format;
+       u8 additional_len;
+       u8 spare[3];
+       char vendor[8];
+       char product[16];
+       char revision[4];
+};
 
-void scsi_print_error(ccb *pccb);
-int scsi_exec(ccb *pccb);
-void scsi_bus_reset(void);
-void scsi_low_level_init(int busdevfunc);
+/**
+ * struct scsi_read_capacity_resp - holds the response to a read-capacity cmd
+ *
+ * @last_block_addr: Logical block address of last block
+ * @block_len: Length of each block in bytes
+ */
+struct scsi_read_capacity_resp {
+       u32 last_block_addr;
+       u32 block_len;
+};
 
+/**
+ * struct scsi_read10_req - holds a SCSI READ10 request
+ *
+ * @cmd; command type
+ * @lun_flags; LUN flags
+ * @lba; Logical block address to start reading from
+ * @spare; spare bytes
+ * @xfer_len: number of blocks to read
+ * @spare2: more spare bytes
+ */
+struct __packed scsi_read10_req {
+       u8 cmd;
+       u8 lun_flags;
+       u32 lba;
+       u8 spare;
+       u16 xfer_len;
+       u8 spare2[3];
+};
 
-/***************************************************************************
- * functions residing inside cmd_scsi.c
+/** struct scsi_write10_req - data for the write10 command */
+struct __packed scsi_write10_req {
+       u8 cmd;
+       u8 lun_flags;
+       u32 lba;
+       u8 spare;
+       u16 xfer_len;
+       u8 spare2[3];
+};
+
+/**
+ * struct scsi_plat - stores information about SCSI controller
+ *
+ * @base: Controller base address
+ * @max_lun: Maximum number of logical units
+ * @max_id: Maximum number of target ids
+ * @max_bytes_per_req: Maximum number of bytes per read/write request
  */
-void scsi_init(void);
-void scsi_scan(int mode);
+struct scsi_plat {
+       unsigned long base;
+       unsigned long max_lun;
+       unsigned long max_id;
+       unsigned long max_bytes_per_req;
+};
+
+/* Operations for SCSI */
+struct scsi_ops {
+       /**
+        * exec() - execute a command
+        *
+        * @dev:        SCSI bus
+        * @cmd:        Command to execute
+        * @return 0 if OK, -ve on error
+        */
+       int (*exec)(struct udevice *dev, struct scsi_cmd *cmd);
+
+       /**
+        * bus_reset() - reset the bus
+        *
+        * @dev:        SCSI bus to reset
+        * @return 0 if OK, -ve on error
+        */
+       int (*bus_reset)(struct udevice *dev);
+};
+
+#define scsi_get_ops(dev)        ((struct scsi_ops *)(dev)->driver->ops)
+
+extern struct scsi_ops scsi_ops;
+
+/**
+ * scsi_exec() - execute a command
+ *
+ * @dev:       SCSI bus
+ * @cmd:       Command to execute
+ * Return: 0 if OK, -ve on error
+ */
+int scsi_exec(struct udevice *dev, struct scsi_cmd *cmd);
+
+/**
+ * scsi_bus_reset() - reset the bus
+ *
+ * @dev:       SCSI bus to reset
+ * Return: 0 if OK, -ve on error
+ */
+int scsi_bus_reset(struct udevice *dev);
+
+/**
+ * scsi_scan() - Scan all SCSI controllers for available devices
+ *
+ * @vebose: true to show information about each device found
+ */
+int scsi_scan(bool verbose);
 
-/** @return the number of scsi disks */
-int scsi_get_disk_count(void);
+/**
+ * scsi_scan_dev() - scan a SCSI bus and create devices
+ *
+ * @dev:       SCSI bus
+ * @verbose:   true to show information about each device found
+ */
+int scsi_scan_dev(struct udevice *dev, bool verbose);
+
+#ifndef CONFIG_DM_SCSI
+void scsi_low_level_init(int busdevfunc);
+void scsi_init(void);
+#endif
 
 #define SCSI_IDENTIFY                                  0xC0  /* not used */