xref: /OK3568_Linux_fs/kernel/drivers/scsi/aha1542.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun #ifndef _AHA1542_H_
3*4882a593Smuzhiyun #define _AHA1542_H_
4*4882a593Smuzhiyun 
5*4882a593Smuzhiyun #include <linux/types.h>
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun /* I/O Port interface 4.2 */
8*4882a593Smuzhiyun /* READ */
9*4882a593Smuzhiyun #define STATUS(base) base
10*4882a593Smuzhiyun #define STST	BIT(7)		/* Self Test in Progress */
11*4882a593Smuzhiyun #define DIAGF	BIT(6)		/* Internal Diagnostic Failure */
12*4882a593Smuzhiyun #define INIT	BIT(5)		/* Mailbox Initialization Required */
13*4882a593Smuzhiyun #define IDLE	BIT(4)		/* SCSI Host Adapter Idle */
14*4882a593Smuzhiyun #define CDF	BIT(3)		/* Command/Data Out Port Full */
15*4882a593Smuzhiyun #define DF	BIT(2)		/* Data In Port Full */
16*4882a593Smuzhiyun /* BIT(1) is reserved */
17*4882a593Smuzhiyun #define INVDCMD	BIT(0)		/* Invalid H A Command */
18*4882a593Smuzhiyun #define STATMASK (STST | DIAGF | INIT | IDLE | CDF | DF | INVDCMD)
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun #define INTRFLAGS(base) (STATUS(base)+2)
21*4882a593Smuzhiyun #define ANYINTR	BIT(7)		/* Any Interrupt */
22*4882a593Smuzhiyun #define SCRD	BIT(3)		/* SCSI Reset Detected */
23*4882a593Smuzhiyun #define HACC	BIT(2)		/* HA Command Complete */
24*4882a593Smuzhiyun #define MBOA	BIT(1)		/* MBO Empty */
25*4882a593Smuzhiyun #define MBIF	BIT(0)		/* MBI Full */
26*4882a593Smuzhiyun #define INTRMASK (ANYINTR | SCRD | HACC | MBOA | MBIF)
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun /* WRITE */
29*4882a593Smuzhiyun #define CONTROL(base) STATUS(base)
30*4882a593Smuzhiyun #define HRST	BIT(7)		/* Hard Reset */
31*4882a593Smuzhiyun #define SRST	BIT(6)		/* Soft Reset */
32*4882a593Smuzhiyun #define IRST	BIT(5)		/* Interrupt Reset */
33*4882a593Smuzhiyun #define SCRST	BIT(4)		/* SCSI Bus Reset */
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun /* READ/WRITE */
36*4882a593Smuzhiyun #define DATA(base) (STATUS(base)+1)
37*4882a593Smuzhiyun #define CMD_NOP		0x00	/* No Operation */
38*4882a593Smuzhiyun #define CMD_MBINIT	0x01	/* Mailbox Initialization */
39*4882a593Smuzhiyun #define CMD_START_SCSI	0x02	/* Start SCSI Command */
40*4882a593Smuzhiyun #define CMD_INQUIRY	0x04	/* Adapter Inquiry */
41*4882a593Smuzhiyun #define CMD_EMBOI	0x05	/* Enable MailBox Out Interrupt */
42*4882a593Smuzhiyun #define CMD_BUSON_TIME	0x07	/* Set Bus-On Time */
43*4882a593Smuzhiyun #define CMD_BUSOFF_TIME	0x08	/* Set Bus-Off Time */
44*4882a593Smuzhiyun #define CMD_DMASPEED	0x09	/* Set AT Bus Transfer Speed */
45*4882a593Smuzhiyun #define CMD_RETDEVS	0x0a	/* Return Installed Devices */
46*4882a593Smuzhiyun #define CMD_RETCONF	0x0b	/* Return Configuration Data */
47*4882a593Smuzhiyun #define CMD_RETSETUP	0x0d	/* Return Setup Data */
48*4882a593Smuzhiyun #define CMD_ECHO	0x1f	/* ECHO Command Data */
49*4882a593Smuzhiyun 
50*4882a593Smuzhiyun #define CMD_EXTBIOS     0x28    /* Return extend bios information only 1542C */
51*4882a593Smuzhiyun #define CMD_MBENABLE    0x29    /* Set Mailbox Interface enable only 1542C */
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun /* Mailbox Definition 5.2.1 and 5.2.2 */
54*4882a593Smuzhiyun struct mailbox {
55*4882a593Smuzhiyun 	u8 status;	/* Command/Status */
56*4882a593Smuzhiyun 	u8 ccbptr[3];	/* msb, .., lsb */
57*4882a593Smuzhiyun };
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun /* This is used with scatter-gather */
60*4882a593Smuzhiyun struct chain {
61*4882a593Smuzhiyun 	u8 datalen[3];	/* Size of this part of chain */
62*4882a593Smuzhiyun 	u8 dataptr[3];	/* Location of data */
63*4882a593Smuzhiyun };
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun /* These belong in scsi.h also */
any2scsi(u8 * p,u32 v)66*4882a593Smuzhiyun static inline void any2scsi(u8 *p, u32 v)
67*4882a593Smuzhiyun {
68*4882a593Smuzhiyun 	p[0] = v >> 16;
69*4882a593Smuzhiyun 	p[1] = v >> 8;
70*4882a593Smuzhiyun 	p[2] = v;
71*4882a593Smuzhiyun }
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun #define scsi2int(up) ( (((long)*(up)) << 16) + (((long)(up)[1]) << 8) + ((long)(up)[2]) )
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun #define xscsi2int(up) ( (((long)(up)[0]) << 24) + (((long)(up)[1]) << 16) \
76*4882a593Smuzhiyun 		      + (((long)(up)[2]) <<  8) +  ((long)(up)[3]) )
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun #define MAX_CDB 12
79*4882a593Smuzhiyun #define MAX_SENSE 14
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun struct ccb {		/* Command Control Block 5.3 */
82*4882a593Smuzhiyun 	u8 op;		/* Command Control Block Operation Code */
83*4882a593Smuzhiyun 	u8 idlun;	/* op=0,2:Target Id, op=1:Initiator Id */
84*4882a593Smuzhiyun 			/* Outbound data transfer, length is checked*/
85*4882a593Smuzhiyun 			/* Inbound data transfer, length is checked */
86*4882a593Smuzhiyun 			/* Logical Unit Number */
87*4882a593Smuzhiyun 	u8 cdblen;	/* SCSI Command Length */
88*4882a593Smuzhiyun 	u8 rsalen;	/* Request Sense Allocation Length/Disable */
89*4882a593Smuzhiyun 	u8 datalen[3];	/* Data Length (msb, .., lsb) */
90*4882a593Smuzhiyun 	u8 dataptr[3];	/* Data Pointer */
91*4882a593Smuzhiyun 	u8 linkptr[3];	/* Link Pointer */
92*4882a593Smuzhiyun 	u8 commlinkid;	/* Command Linking Identifier */
93*4882a593Smuzhiyun 	u8 hastat;	/* Host Adapter Status (HASTAT) */
94*4882a593Smuzhiyun 	u8 tarstat;	/* Target Device Status */
95*4882a593Smuzhiyun 	u8 reserved[2];
96*4882a593Smuzhiyun 	u8 cdb[MAX_CDB+MAX_SENSE];	/* SCSI Command Descriptor Block */
97*4882a593Smuzhiyun 					/* REQUEST SENSE */
98*4882a593Smuzhiyun };
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun #define AHA1542_REGION_SIZE 4
101*4882a593Smuzhiyun #define AHA1542_MAILBOXES 8
102*4882a593Smuzhiyun 
103*4882a593Smuzhiyun #endif /* _AHA1542_H_ */
104