xref: /freebsd/sys/cam/ata/ata_all.h (revision 43764a7ffa9ad6eba3275410bc2397d3d398f75f)
1 /*-
2  * Copyright (c) 2009 Alexander Motin <mav@FreeBSD.org>
3  * All rights reserved.
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  *    without modification, immediately at the beginning of the file.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef	CAM_ATA_ALL_H
30 #define CAM_ATA_ALL_H 1
31 
32 #include <sys/ata.h>
33 
34 struct ccb_ataio;
35 struct cam_periph;
36 union  ccb;
37 
38 #define	SID_DMA		0x10	/* Abuse inq_flags bit to track enabled DMA. */
39 
40 struct ata_cmd {
41 	u_int8_t	flags;		/* ATA command flags */
42 #define		CAM_ATAIO_48BIT		0x01	/* Command has 48-bit format */
43 #define		CAM_ATAIO_FPDMA		0x02	/* FPDMA command */
44 #define		CAM_ATAIO_CONTROL	0x04	/* Control, not a command */
45 #define		CAM_ATAIO_NEEDRESULT	0x08	/* Request requires result. */
46 #define		CAM_ATAIO_DMA		0x10	/* DMA command */
47 
48 	u_int8_t	command;
49 	u_int8_t	features;
50 
51 	u_int8_t	lba_low;
52 	u_int8_t	lba_mid;
53 	u_int8_t	lba_high;
54 	u_int8_t	device;
55 
56 	u_int8_t	lba_low_exp;
57 	u_int8_t	lba_mid_exp;
58 	u_int8_t	lba_high_exp;
59 	u_int8_t	features_exp;
60 
61 	u_int8_t	sector_count;
62 	u_int8_t	sector_count_exp;
63 	u_int8_t	control;
64 };
65 
66 struct ata_res {
67 	u_int8_t	flags;		/* ATA command flags */
68 #define		CAM_ATAIO_48BIT		0x01	/* Command has 48-bit format */
69 
70 	u_int8_t	status;
71 	u_int8_t	error;
72 
73 	u_int8_t	lba_low;
74 	u_int8_t	lba_mid;
75 	u_int8_t	lba_high;
76 	u_int8_t	device;
77 
78 	u_int8_t	lba_low_exp;
79 	u_int8_t	lba_mid_exp;
80 	u_int8_t	lba_high_exp;
81 
82 	u_int8_t	sector_count;
83 	u_int8_t	sector_count_exp;
84 };
85 
86 int	ata_version(int ver);
87 
88 char *	ata_op_string(struct ata_cmd *cmd);
89 char *	ata_cmd_string(struct ata_cmd *cmd, char *cmd_string, size_t len);
90 char *	ata_res_string(struct ata_res *res, char *res_string, size_t len);
91 int	ata_command_sbuf(struct ccb_ataio *ataio, struct sbuf *sb);
92 int	ata_status_sbuf(struct ccb_ataio *ataio, struct sbuf *sb);
93 int	ata_res_sbuf(struct ccb_ataio *ataio, struct sbuf *sb);
94 
95 void	ata_print_ident(struct ata_params *ident_data);
96 
97 uint32_t	ata_logical_sector_size(struct ata_params *ident_data);
98 uint64_t	ata_physical_sector_size(struct ata_params *ident_data);
99 uint64_t	ata_logical_sector_offset(struct ata_params *ident_data);
100 
101 void	ata_28bit_cmd(struct ccb_ataio *ataio, uint8_t cmd, uint8_t features,
102     uint32_t lba, uint8_t sector_count);
103 void	ata_48bit_cmd(struct ccb_ataio *ataio, uint8_t cmd, uint16_t features,
104     uint64_t lba, uint16_t sector_count);
105 void	ata_ncq_cmd(struct ccb_ataio *ataio, uint8_t cmd,
106     uint64_t lba, uint16_t sector_count);
107 void	ata_reset_cmd(struct ccb_ataio *ataio);
108 void	ata_pm_read_cmd(struct ccb_ataio *ataio, int reg, int port);
109 void	ata_pm_write_cmd(struct ccb_ataio *ataio, int reg, int port, uint32_t val);
110 
111 void	ata_bswap(int8_t *buf, int len);
112 void	ata_btrim(int8_t *buf, int len);
113 void	ata_bpack(int8_t *src, int8_t *dst, int len);
114 
115 int	ata_max_pmode(struct ata_params *ap);
116 int	ata_max_wmode(struct ata_params *ap);
117 int	ata_max_umode(struct ata_params *ap);
118 int	ata_max_mode(struct ata_params *ap, int maxmode);
119 
120 char *	ata_mode2string(int mode);
121 int	ata_string2mode(char *str);
122 u_int	ata_mode2speed(int mode);
123 u_int	ata_revision2speed(int revision);
124 int	ata_speed2revision(u_int speed);
125 
126 int	ata_identify_match(caddr_t identbuffer, caddr_t table_entry);
127 int	ata_static_identify_match(caddr_t identbuffer, caddr_t table_entry);
128 
129 #endif
130