xref: /OK3568_Linux_fs/kernel/drivers/ata/sata_promise.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  *  sata_promise.h - Promise SATA common definitions and inline funcs
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  *  Copyright 2003-2004 Red Hat, Inc.
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  *  libata documentation is available via 'make {ps|pdf}docs',
8*4882a593Smuzhiyun  *  as Documentation/driver-api/libata.rst
9*4882a593Smuzhiyun  */
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #ifndef __SATA_PROMISE_H__
12*4882a593Smuzhiyun #define __SATA_PROMISE_H__
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #include <linux/ata.h>
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun enum pdc_packet_bits {
17*4882a593Smuzhiyun 	PDC_PKT_READ		= (1 << 2),
18*4882a593Smuzhiyun 	PDC_PKT_NODATA		= (1 << 3),
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun 	PDC_PKT_SIZEMASK	= (1 << 7) | (1 << 6) | (1 << 5),
21*4882a593Smuzhiyun 	PDC_PKT_CLEAR_BSY	= (1 << 4),
22*4882a593Smuzhiyun 	PDC_PKT_WAIT_DRDY	= (1 << 3) | (1 << 4),
23*4882a593Smuzhiyun 	PDC_LAST_REG		= (1 << 3),
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun 	PDC_REG_DEVCTL		= (1 << 3) | (1 << 2) | (1 << 1),
26*4882a593Smuzhiyun };
27*4882a593Smuzhiyun 
pdc_pkt_header(struct ata_taskfile * tf,dma_addr_t sg_table,unsigned int devno,u8 * buf)28*4882a593Smuzhiyun static inline unsigned int pdc_pkt_header(struct ata_taskfile *tf,
29*4882a593Smuzhiyun 					  dma_addr_t sg_table,
30*4882a593Smuzhiyun 					  unsigned int devno, u8 *buf)
31*4882a593Smuzhiyun {
32*4882a593Smuzhiyun 	u8 dev_reg;
33*4882a593Smuzhiyun 	__le32 *buf32 = (__le32 *) buf;
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun 	/* set control bits (byte 0), zero delay seq id (byte 3),
36*4882a593Smuzhiyun 	 * and seq id (byte 2)
37*4882a593Smuzhiyun 	 */
38*4882a593Smuzhiyun 	switch (tf->protocol) {
39*4882a593Smuzhiyun 	case ATA_PROT_DMA:
40*4882a593Smuzhiyun 		if (!(tf->flags & ATA_TFLAG_WRITE))
41*4882a593Smuzhiyun 			buf32[0] = cpu_to_le32(PDC_PKT_READ);
42*4882a593Smuzhiyun 		else
43*4882a593Smuzhiyun 			buf32[0] = 0;
44*4882a593Smuzhiyun 		break;
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun 	case ATA_PROT_NODATA:
47*4882a593Smuzhiyun 		buf32[0] = cpu_to_le32(PDC_PKT_NODATA);
48*4882a593Smuzhiyun 		break;
49*4882a593Smuzhiyun 
50*4882a593Smuzhiyun 	default:
51*4882a593Smuzhiyun 		BUG();
52*4882a593Smuzhiyun 		break;
53*4882a593Smuzhiyun 	}
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun 	buf32[1] = cpu_to_le32(sg_table);	/* S/G table addr */
56*4882a593Smuzhiyun 	buf32[2] = 0;				/* no next-packet */
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun 	if (devno == 0)
59*4882a593Smuzhiyun 		dev_reg = ATA_DEVICE_OBS;
60*4882a593Smuzhiyun 	else
61*4882a593Smuzhiyun 		dev_reg = ATA_DEVICE_OBS | ATA_DEV1;
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun 	/* select device */
64*4882a593Smuzhiyun 	buf[12] = (1 << 5) | PDC_PKT_CLEAR_BSY | ATA_REG_DEVICE;
65*4882a593Smuzhiyun 	buf[13] = dev_reg;
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun 	/* device control register */
68*4882a593Smuzhiyun 	buf[14] = (1 << 5) | PDC_REG_DEVCTL;
69*4882a593Smuzhiyun 	buf[15] = tf->ctl;
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun 	return 16; 	/* offset of next byte */
72*4882a593Smuzhiyun }
73*4882a593Smuzhiyun 
pdc_pkt_footer(struct ata_taskfile * tf,u8 * buf,unsigned int i)74*4882a593Smuzhiyun static inline unsigned int pdc_pkt_footer(struct ata_taskfile *tf, u8 *buf,
75*4882a593Smuzhiyun 				  unsigned int i)
76*4882a593Smuzhiyun {
77*4882a593Smuzhiyun 	if (tf->flags & ATA_TFLAG_DEVICE) {
78*4882a593Smuzhiyun 		buf[i++] = (1 << 5) | ATA_REG_DEVICE;
79*4882a593Smuzhiyun 		buf[i++] = tf->device;
80*4882a593Smuzhiyun 	}
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun 	/* and finally the command itself; also includes end-of-pkt marker */
83*4882a593Smuzhiyun 	buf[i++] = (1 << 5) | PDC_LAST_REG | ATA_REG_CMD;
84*4882a593Smuzhiyun 	buf[i++] = tf->command;
85*4882a593Smuzhiyun 
86*4882a593Smuzhiyun 	return i;
87*4882a593Smuzhiyun }
88*4882a593Smuzhiyun 
pdc_prep_lba28(struct ata_taskfile * tf,u8 * buf,unsigned int i)89*4882a593Smuzhiyun static inline unsigned int pdc_prep_lba28(struct ata_taskfile *tf, u8 *buf, unsigned int i)
90*4882a593Smuzhiyun {
91*4882a593Smuzhiyun 	/* the "(1 << 5)" should be read "(count << 5)" */
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun 	/* ATA command block registers */
94*4882a593Smuzhiyun 	buf[i++] = (1 << 5) | ATA_REG_FEATURE;
95*4882a593Smuzhiyun 	buf[i++] = tf->feature;
96*4882a593Smuzhiyun 
97*4882a593Smuzhiyun 	buf[i++] = (1 << 5) | ATA_REG_NSECT;
98*4882a593Smuzhiyun 	buf[i++] = tf->nsect;
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun 	buf[i++] = (1 << 5) | ATA_REG_LBAL;
101*4882a593Smuzhiyun 	buf[i++] = tf->lbal;
102*4882a593Smuzhiyun 
103*4882a593Smuzhiyun 	buf[i++] = (1 << 5) | ATA_REG_LBAM;
104*4882a593Smuzhiyun 	buf[i++] = tf->lbam;
105*4882a593Smuzhiyun 
106*4882a593Smuzhiyun 	buf[i++] = (1 << 5) | ATA_REG_LBAH;
107*4882a593Smuzhiyun 	buf[i++] = tf->lbah;
108*4882a593Smuzhiyun 
109*4882a593Smuzhiyun 	return i;
110*4882a593Smuzhiyun }
111*4882a593Smuzhiyun 
pdc_prep_lba48(struct ata_taskfile * tf,u8 * buf,unsigned int i)112*4882a593Smuzhiyun static inline unsigned int pdc_prep_lba48(struct ata_taskfile *tf, u8 *buf, unsigned int i)
113*4882a593Smuzhiyun {
114*4882a593Smuzhiyun 	/* the "(2 << 5)" should be read "(count << 5)" */
115*4882a593Smuzhiyun 
116*4882a593Smuzhiyun 	/* ATA command block registers */
117*4882a593Smuzhiyun 	buf[i++] = (2 << 5) | ATA_REG_FEATURE;
118*4882a593Smuzhiyun 	buf[i++] = tf->hob_feature;
119*4882a593Smuzhiyun 	buf[i++] = tf->feature;
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun 	buf[i++] = (2 << 5) | ATA_REG_NSECT;
122*4882a593Smuzhiyun 	buf[i++] = tf->hob_nsect;
123*4882a593Smuzhiyun 	buf[i++] = tf->nsect;
124*4882a593Smuzhiyun 
125*4882a593Smuzhiyun 	buf[i++] = (2 << 5) | ATA_REG_LBAL;
126*4882a593Smuzhiyun 	buf[i++] = tf->hob_lbal;
127*4882a593Smuzhiyun 	buf[i++] = tf->lbal;
128*4882a593Smuzhiyun 
129*4882a593Smuzhiyun 	buf[i++] = (2 << 5) | ATA_REG_LBAM;
130*4882a593Smuzhiyun 	buf[i++] = tf->hob_lbam;
131*4882a593Smuzhiyun 	buf[i++] = tf->lbam;
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun 	buf[i++] = (2 << 5) | ATA_REG_LBAH;
134*4882a593Smuzhiyun 	buf[i++] = tf->hob_lbah;
135*4882a593Smuzhiyun 	buf[i++] = tf->lbah;
136*4882a593Smuzhiyun 
137*4882a593Smuzhiyun 	return i;
138*4882a593Smuzhiyun }
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun #endif /* __SATA_PROMISE_H__ */
142