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