libpayload: New AHCI, ATA and ATAPI drivers

This adds a new interface for storage devices. A driver for ATA and
ATAPI drives on AHCI host controllers comes along.

The interface is very simple and was designed to match FILO's needs.
It consists of three functions:

  void storage_initialize(void);
  Initializes controllers. Should be called once at startup.

  storage_poll_t storage_probe(size_t dev_num);
     with typedef enum {
            POLL_NO_DEVICE      = -2,
            POLL_ERROR          = -1,
            POLL_NO_MEDIUM      =  0,
            POLL_MEDIUM_PRESENT =  1,
          } storage_poll_t;
  Looks for a drive with number dev_num (drives are counted from
  zero) and polls for a medium in the drive if appropriate.

  int storage_read_blocks512(size_t dev_num,
                             u64 start, size_t count,
                             unsigned char *buf);
  Reads count blocks of 512 bytes from block start of drive dev_num
  into buf.

Change-Id: I1c85796b7f8e379ff3817a61b1837636b57e182b
Signed-off-by: Nico Huber <nico.huber@secunet.com>
Reviewed-on: http://review.coreboot.org/1622
Tested-by: build bot (Jenkins)
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
Reviewed-by: Peter Stuge <peter@stuge.se>

6 files changed, 283 insertions, 0 deletions

diff --git a/payloads/libpayload/include/libpayload.h b/payloads/libpayload/include/libpayload.h
index 2deb9613a1..c3729e2b4d 100644
--- a/payloads/libpayload/include/libpayload.h
+++ b/payloads/libpayload/include/libpayload.h
@@ -119,6 +119,13 @@ void rtc_read_clock(struct tm *tm);
 /** @} */
 
 /**
+ * @defgroup storage driver functions
+ * @{
+ */
+void storage_initialize(void);
+/** @} */
+
+/**
  * @defgroup usb USB functions
  * @{
  */
diff --git a/payloads/libpayload/include/storage/ahci.h b/payloads/libpayload/include/storage/ahci.h
new file mode 100644
index 0000000000..eae78aa8aa
--- /dev/null
+++ b/payloads/libpayload/include/storage/ahci.h
@@ -0,0 +1,35 @@
+/*
+ * This file is part of the libpayload project.
+ *
+ * Copyright (C) 2012 secunet Security Networks AG
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+#ifndef _STORAGE_AHCI_H
+#define _STORAGE_AHCI_H
+
+void ahci_initialize(void);
+
+#endif
diff --git a/payloads/libpayload/include/storage/ata.h b/payloads/libpayload/include/storage/ata.h
new file mode 100644
index 0000000000..c8422490e3
--- /dev/null
+++ b/payloads/libpayload/include/storage/ata.h
@@ -0,0 +1,77 @@
+/*
+ * This file is part of the libpayload project.
+ *
+ * Copyright (C) 2012 secunet Security Networks AG
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+#ifndef _STORAGE_ATA_H
+#define _STORAGE_ATA_H
+
+#include <stdint.h>
+
+#include "storage.h"
+
+
+/* ATA commands */
+enum {
+	ATA_READ_DMA			= 0xc8,
+	ATA_READ_DMA_EXT		= 0x25,
+	ATA_IDENTIFY_DEVICE		= 0xec,
+	ATA_PACKET			= 0xa0,
+	ATA_IDENTIFY_PACKET_DEVICE	= 0xa1,
+};
+
+/* 16-bit-word indices into id structure from ATA_IDENTIFY_DEVICE */
+enum {
+	ATA_CMDS_AND_FEATURE_SETS	=  82,
+	ATA_ID_SECTOR_SIZE		= 106,
+	ATA_ID_LOGICAL_SECTOR_SIZE	= 117,
+};
+
+#define DEFAULT_ATA_SECTOR_SIZE 512
+
+struct ata_dev;
+typedef struct ata_dev {
+	storage_dev_t storage_dev;
+
+	int (*identify)(struct ata_dev *, u8 *buf);
+	ssize_t (*read_sectors)(struct ata_dev *, lba_t start, size_t count, u8 *buf);
+
+	u8 read_cmd;
+	u8 identify_cmd;
+	size_t sector_size;
+	size_t sector_size_shift;
+
+	void (*detach_device)(struct ata_dev *);
+} ata_dev_t;
+
+int ata_attach_device(ata_dev_t *, storage_port_t);
+
+char *ata_strncpy(char *dest, const u16 *src, size_t n);
+int ata_set_sector_size(ata_dev_t *, u32 sector_size);
+void ata_initialize_storage_ops(ata_dev_t *);
+
+#endif
diff --git a/payloads/libpayload/include/storage/atapi.h b/payloads/libpayload/include/storage/atapi.h
new file mode 100644
index 0000000000..224c598ed3
--- /dev/null
+++ b/payloads/libpayload/include/storage/atapi.h
@@ -0,0 +1,78 @@
+/*
+ * This file is part of the libpayload project.
+ *
+ * Copyright (C) 2012 secunet Security Networks AG
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+#ifndef _STORAGE_ATAPI_H
+#define _STORAGE_ATAPI_H
+
+#include <stdint.h>
+
+#include "storage.h"
+#include "ata.h"
+
+
+/* ATAPI commands */
+enum {
+	ATAPI_TEST_UNIT_READY			= 0x00,
+	ATAPI_REQUEST_SENSE			= 0x03,
+	ATAPI_START_STOP_UNIT			= 0x1b,
+	ATAPI_PREVENT_ALLOW_MEDIUM_REMOVAL	= 0x1e,
+	ATAPI_READ_CAPACITY			= 0x25,
+	ATAPI_READ_10				= 0x28,
+};
+
+/* ATAPI sense codes */
+enum {
+	ATAPI_SENSE_NOT_READY		= 0x02,
+	ATAPI_SENSE_UNIT_ATTENTION	= 0x06,
+};
+
+/* ATAPI additional sense codes (particularize the above) */
+enum {
+	ATAPI_ADDITIONAL_SENSE_LOGICAL_UNIT_NOT_READY	= 0x04,
+	ATAPI_ADDITIONAL_SENSE_MEDIUM_NOT_PRESENT	= 0x3a,
+};
+
+struct atapi_dev;
+
+typedef struct atapi_dev {
+	/* Keep this at offset 0 so we can cast to ata_dev_t. */
+	ata_dev_t ata_dev;
+
+	int (*identify)(struct ata_dev *, u8 *buf); /* yes, ata_dev_t */
+	ssize_t (*packet_read_cmd)(struct atapi_dev *, const u8 *cmd, size_t cmdlen, u8 *buf, size_t buflen);
+
+	u8 sense_data[19]; /* We needed 19 in usbmsc.c. */
+	u8 medium_present;
+
+	void (*detach_device)(struct atapi_dev *);
+} atapi_dev_t;
+
+int atapi_attach_device(atapi_dev_t *, storage_port_t);
+
+#endif
diff --git a/payloads/libpayload/include/storage/storage.h b/payloads/libpayload/include/storage/storage.h
new file mode 100644
index 0000000000..3958c4b3c6
--- /dev/null
+++ b/payloads/libpayload/include/storage/storage.h
@@ -0,0 +1,77 @@
+/*
+ * This file is part of the libpayload project.
+ *
+ * Copyright (C) 2012 secunet Security Networks AG
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+#ifndef _STORAGE_STORAGE_H
+#define _STORAGE_STORAGE_H
+
+#include <stdint.h>
+#include <unistd.h>
+
+
+#ifndef CONFIG_STORAGE_64BIT_LBA
+typedef u32 lba_t;
+#else
+typedef u64 lba_t;
+#endif
+
+
+typedef enum {
+	PORT_TYPE_IDE	= (1 << 0),
+	PORT_TYPE_SATA	= (1 << 1),
+	PORT_TYPE_USB	= (1 << 2),
+} storage_port_t;
+
+typedef enum {
+	POLL_MEDIUM_ERROR	= -3,
+	POLL_NO_DEVICE		= -2,
+	POLL_ERROR		= -1,
+	POLL_NO_MEDIUM		=  0,
+	POLL_MEDIUM_PRESENT	=  1,
+} storage_poll_t;
+
+
+struct storage_dev;
+
+typedef struct storage_dev {
+	storage_port_t port_type;
+
+	storage_poll_t (*poll)(struct storage_dev *);
+	ssize_t (*read_blocks512)(struct storage_dev *, lba_t start, size_t count, unsigned char *buf);
+	ssize_t (*write_blocks512)(struct storage_dev *, lba_t start, size_t count, const unsigned char *buf);
+
+	void (*detach_device)(struct storage_dev *);
+} storage_dev_t;
+
+int storage_attach_device(storage_dev_t *dev);
+
+
+storage_poll_t storage_probe(size_t dev_num);
+ssize_t storage_read_blocks512(size_t dev_num, lba_t start, size_t count, unsigned char *buf);
+
+#endif
diff --git a/payloads/libpayload/include/unistd.h b/payloads/libpayload/include/unistd.h
index 878638d419..1e39aeb058 100644
--- a/payloads/libpayload/include/unistd.h
+++ b/payloads/libpayload/include/unistd.h
@@ -27,4 +27,13 @@
  * SUCH DAMAGE.
  */
 
+#ifndef _UNISTD_H
+#define _UNISTD_H
+
+#include <stddef.h>
+
+typedef ptrdiff_t ssize_t;
+
 int getpagesize(void);
+
+#endif