xref: /freebsd/sys/dev/aic7xxx/aic7xxx_93cx6.h (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
1 /*
2  * Interface to the 93C46 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 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  * the 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  * $FreeBSD$
34  */
35 
36 #include <sys/param.h>
37 #if !defined(__NetBSD__)
38 #include <sys/systm.h>
39 #endif
40 
41 #ifdef _KERNEL
42 
43 typedef enum {
44 	C46 = 6,
45 	C56_66 = 8
46 } seeprom_chip_t;
47 
48 struct seeprom_descriptor {
49 	bus_space_tag_t sd_tag;
50 	bus_space_handle_t sd_bsh;
51 	bus_size_t sd_control_offset;
52 	bus_size_t sd_status_offset;
53 	bus_size_t sd_dataout_offset;
54 	seeprom_chip_t sd_chip;
55 	u_int16_t sd_MS;
56 	u_int16_t sd_RDY;
57 	u_int16_t sd_CS;
58 	u_int16_t sd_CK;
59 	u_int16_t sd_DO;
60 	u_int16_t sd_DI;
61 };
62 
63 /*
64  * This function will read count 16-bit words from the serial EEPROM and
65  * return their value in buf.  The port address of the aic7xxx serial EEPROM
66  * control register is passed in as offset.  The following parameters are
67  * also passed in:
68  *
69  *   CS  - Chip select
70  *   CK  - Clock
71  *   DO  - Data out
72  *   DI  - Data in
73  *   RDY - SEEPROM ready
74  *   MS  - Memory port mode select
75  *
76  *  A failed read attempt returns 0, and a successful read returns 1.
77  */
78 
79 #define	SEEPROM_INB(sd) \
80 	bus_space_read_1(sd->sd_tag, sd->sd_bsh, sd->sd_control_offset)
81 #define	SEEPROM_OUTB(sd, value) \
82 	bus_space_write_1(sd->sd_tag, sd->sd_bsh, sd->sd_control_offset, value)
83 #define	SEEPROM_STATUS_INB(sd) \
84 	bus_space_read_1(sd->sd_tag, sd->sd_bsh, sd->sd_status_offset)
85 #define	SEEPROM_DATA_INB(sd) \
86 	bus_space_read_1(sd->sd_tag, sd->sd_bsh, sd->sd_dataout_offset)
87 
88 int read_seeprom(struct seeprom_descriptor *sd, u_int16_t *buf,
89 		 bus_size_t start_addr, bus_size_t count);
90 
91 #endif /* _KERNEL */
92