xref: /freebsd/sys/dev/aic7xxx/aic7xxx_93cx6.h (revision 1b6c76a2fe091c74f08427e6c870851025a9cf67)
1 /*
2  * Interface to the 93C46/56 serial EEPROM that is used to store BIOS
3  * settings for the aic7xxx based adaptec SCSI controllers.  It can
4  * also be used for 93C26 and 93C06 serial EEPROMS.
5  *
6  * Copyright (c) 1994, 1995, 2000 Justin T. Gibbs.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions, and the following disclaimer,
14  *    without modification.
15  * 2. The name of the author may not be used to endorse or promote products
16  *    derived from this software without specific prior written permission.
17  *
18  * Alternatively, this software may be distributed under the terms of the
19  * GNU Public License ("GPL").
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
25  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * $Id: //depot/src/aic7xxx/aic7xxx_93cx6.h#5 $
34  *
35  * $FreeBSD$
36  */
37 #ifndef _AIC7XXX_93CX6_H_
38 #define _AIC7XXX_93CX6_H_
39 
40 typedef enum {
41 	C46 = 6,
42 	C56_66 = 8
43 } seeprom_chip_t;
44 
45 struct seeprom_descriptor {
46 	struct ahc_softc *sd_ahc;
47 	u_int sd_control_offset;
48 	u_int sd_status_offset;
49 	u_int sd_dataout_offset;
50 	seeprom_chip_t sd_chip;
51 	uint16_t sd_MS;
52 	uint16_t sd_RDY;
53 	uint16_t sd_CS;
54 	uint16_t sd_CK;
55 	uint16_t sd_DO;
56 	uint16_t sd_DI;
57 };
58 
59 /*
60  * This function will read count 16-bit words from the serial EEPROM and
61  * return their value in buf.  The port address of the aic7xxx serial EEPROM
62  * control register is passed in as offset.  The following parameters are
63  * also passed in:
64  *
65  *   CS  - Chip select
66  *   CK  - Clock
67  *   DO  - Data out
68  *   DI  - Data in
69  *   RDY - SEEPROM ready
70  *   MS  - Memory port mode select
71  *
72  *  A failed read attempt returns 0, and a successful read returns 1.
73  */
74 
75 #define	SEEPROM_INB(sd) \
76 	ahc_inb(sd->sd_ahc, sd->sd_control_offset)
77 #define	SEEPROM_OUTB(sd, value)					\
78 do {								\
79 	ahc_outb(sd->sd_ahc, sd->sd_control_offset, value);	\
80 	ahc_flush_device_writes(sd->sd_ahc);			\
81 } while(0)
82 
83 #define	SEEPROM_STATUS_INB(sd) \
84 	ahc_inb(sd->sd_ahc, sd->sd_status_offset)
85 #define	SEEPROM_DATA_INB(sd) \
86 	ahc_inb(sd->sd_ahc, sd->sd_dataout_offset)
87 
88 int read_seeprom(struct seeprom_descriptor *sd, uint16_t *buf,
89 		 u_int start_addr, u_int count);
90 int verify_cksum(struct seeprom_config *sc);
91 
92 #endif /* _AIC7XXX_93CX6_H_ */
93