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>

1 files changed, 77 insertions, 0 deletions

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