xref: /aosp_15_r20/external/coreboot/payloads/libpayload/include/storage/ata.h (revision b9411a12aaaa7e1e6a6fb7c5e057f44ee179a49c)
1 /*
2  *
3  * Copyright (C) 2012 secunet Security Networks AG
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _STORAGE_ATA_H
30 #define _STORAGE_ATA_H
31 
32 #include <stdint.h>
33 
34 #include "storage.h"
35 
36 /* ATA commands */
37 enum {
38 	ATA_READ_DMA			= 0xc8,
39 	ATA_READ_DMA_EXT		= 0x25,
40 	ATA_IDENTIFY_DEVICE		= 0xec,
41 	ATA_PACKET			= 0xa0,
42 	ATA_IDENTIFY_PACKET_DEVICE	= 0xa1,
43 };
44 
45 /* 16-bit-word indices into id structure from ATA_IDENTIFY_DEVICE */
46 enum {
47 	ATA_CMDS_AND_FEATURE_SETS	=  82,
48 	ATA_ID_SECTOR_SIZE		= 106,
49 	ATA_ID_LOGICAL_SECTOR_SIZE	= 117,
50 };
51 
52 #define DEFAULT_ATA_SECTOR_SIZE 512
53 
54 struct ata_dev;
55 typedef struct ata_dev {
56 	storage_dev_t storage_dev;
57 
58 	int (*identify)(struct ata_dev *, u8 *buf);
59 	ssize_t (*read_sectors)(struct ata_dev *, lba_t start, size_t count, u8 *buf);
60 
61 	u8 read_cmd;
62 	u8 identify_cmd;
63 	size_t sector_size;
64 	size_t sector_size_shift;
65 
66 	void (*detach_device)(struct ata_dev *);
67 } ata_dev_t;
68 
69 int ata_attach_device(ata_dev_t *, storage_port_t);
70 
71 char *ata_strncpy(char *dest, const u16 *src, size_t n);
72 int ata_set_sector_size(ata_dev_t *, u32 sector_size);
73 void ata_initialize_storage_ops(ata_dev_t *);
74 
75 #endif
76