xref: /freebsd/sys/dev/bhnd/bcma/bcma_eromvar.h (revision d48a2d23039536ab9f92f88a72c27b9895796abf)
1 /*-
2  * Copyright (c) 2015 Landon Fuller <landon@landonf.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer,
10  *    without modification.
11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13  *    redistribution must be conditioned upon including a substantially
14  *    similar Disclaimer requirement for further binary redistribution.
15  *
16  * NO WARRANTY
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27  * THE POSSIBILITY OF SUCH DAMAGES.
28  *
29  * $FreeBSD$
30  */
31 
32 #ifndef	_BCMA_BCMA_EROMVAR_H_
33 #define	_BCMA_BCMA_EROMVAR_H_
34 
35 #include <dev/bhnd/bhnd.h>
36 
37 #include "bcmavar.h"
38 
39 /**
40  * EROM read context.
41  */
42 struct bcma_erom {
43 	device_t	 dev;		/**< EROM parent device */
44 	struct resource	*r;		/**< EROM table resource. */
45 	bus_size_t	 start;		/**< EROM table offset */
46 	bus_size_t	 offset;	/**< current read offset */
47 };
48 
49 /** EROM core descriptor. */
50 struct bcma_erom_core {
51 	uint16_t	vendor;		/**< core's designer */
52 	uint16_t	device;		/**< core's device identifier */
53 	uint16_t	rev;		/**< core's hardware revision */
54 	u_long		num_mport;	/**< number of master port descriptors */
55 	u_long		num_dport;	/**< number of slave port descriptors */
56 	u_long		num_mwrap;	/**< number of master wrapper slave port descriptors */
57 	u_long		num_swrap;	/**< number of slave wrapper slave port descriptors */
58 };
59 
60 /** EROM master port descriptor. */
61 struct bcma_erom_mport {
62 	uint8_t		port_num;	/**< the port number (bus-unique) */
63 	uint8_t		port_vid;	/**< the port VID. A single physical
64 					     master port may have multiple VIDs;
65 					     the canonical port address is
66 					     composed of the port number + the
67 					     port VID */
68 };
69 
70 /** EROM slave port region descriptor. */
71 struct bcma_erom_sport_region {
72 	uint8_t		region_port;	/**< the slave port mapping this region */
73 	uint8_t		region_type;	/**< the mapping port's type */
74 	bhnd_addr_t	base_addr;	/**< region base address */
75 	bhnd_addr_t	size;		/**< region size */
76 };
77 
78 int		bcma_erom_open(struct bcma_erom *erom, struct resource *r,
79 		    bus_size_t offset);
80 
81 int		bcma_erom_peek32(struct bcma_erom *erom, uint32_t *entry);
82 bus_size_t	bcma_erom_tell(struct bcma_erom *erom);
83 void		bcma_erom_seek(struct bcma_erom *erom, bus_size_t offset);
84 void		bcma_erom_reset(struct bcma_erom *erom);
85 
86 int		bcma_erom_seek_core_index(struct bcma_erom *erom,
87 		    u_int core_index);
88 int		bcma_erom_parse_core(struct bcma_erom *erom,
89 		    struct bcma_erom_core *core);
90 
91 int		bcma_erom_parse_mport(struct bcma_erom *erom,
92 		    struct bcma_erom_mport *mport);
93 
94 int		bcma_erom_parse_sport_region(struct bcma_erom *erom,
95 		    struct bcma_erom_sport_region *region);
96 
97 int		bcma_erom_get_core_info(struct bcma_erom *erom,
98 		    struct bhnd_core_info **cores,
99 		    u_int *num_cores);
100 
101 int		bcma_erom_parse_corecfg(struct bcma_erom *erom,
102 		    struct bcma_corecfg **result);
103 
104 #endif /* _BCMA_BCMA_EROMVAR_H_ */
105