xref: /netbsd-src/sys/arch/arm/nxp/imx6_ocotp.c (revision 90313c06e62e910bf0d1bb24faa9d17dcefd0ab6)
1 /*	$NetBSD: imx6_ocotp.c,v 1.3 2024/02/07 04:20:27 msaitoh Exp $	*/
2 
3 /*
4  * Copyright (c) 2014 Ryo Shimizu
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
25  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /*
30  * i.MX6 On-Chip OTP Controller
31  */
32 
33 #include <sys/cdefs.h>
34 __KERNEL_RCSID(0, "$NetBSD: imx6_ocotp.c,v 1.3 2024/02/07 04:20:27 msaitoh Exp $");
35 
36 #include <sys/bus.h>
37 #include <sys/device.h>
38 #include <sys/param.h>
39 
40 #include <dev/fdt/fdtvar.h>
41 
42 #include <arm/nxp/imx6_ocotpreg.h>
43 #include <arm/nxp/imx6_ocotpvar.h>
44 
45 struct imxocotp_softc {
46 	device_t sc_dev;
47 
48 	bus_addr_t sc_addr;
49 	bus_space_tag_t sc_iot;
50 	bus_space_handle_t sc_ioh;
51 	bus_size_t sc_ios;
52 
53 	struct clk *sc_clk;
54 
55 };
56 
57 static struct imxocotp_softc *ocotp_softc;
58 
59 static int imxocotp_match(device_t, struct cfdata *, void *);
60 static void imxocotp_attach(device_t, device_t, void *);
61 
62 CFATTACH_DECL_NEW(imxocotp, sizeof(struct imxocotp_softc),
63     imxocotp_match, imxocotp_attach, NULL, NULL);
64 
65 static const struct device_compatible_entry compat_data[] = {
66 	{ .compat = "fsl,imx6q-ocotp" },
67 	{ .compat = "fsl,imx6sl-ocotp" },
68 	{ .compat = "fsl,imx6sll-ocotp" },
69 	{ .compat = "fsl,imx6sx-ocotp" },
70 	{ .compat = "fsl,imx6ul-ocotp" },
71 	{ .compat = "fsl,imx6ull-ocotp" },
72 	DEVICE_COMPAT_EOL
73 };
74 
75 int
imxocotp_match(device_t parent,cfdata_t cf,void * aux)76 imxocotp_match(device_t parent, cfdata_t cf, void *aux)
77 {
78 	struct fdt_attach_args * const faa = aux;
79 
80 	if (ocotp_softc != NULL)
81 		return 0;
82 
83 	return of_compatible_match(faa->faa_phandle, compat_data);
84 }
85 
86 /* ARGSUSED */
87 static void
imxocotp_attach(device_t parent,device_t self,void * aux)88 imxocotp_attach(device_t parent, device_t self, void *aux)
89 {
90 	struct imxocotp_softc *sc = device_private(self);
91 	struct fdt_attach_args * const faa = aux;
92 	const int phandle = faa->faa_phandle;
93 	bus_addr_t addr;
94 	bus_size_t size;
95 	int error;
96 
97 	sc->sc_iot = faa->faa_bst;
98 	if (fdtbus_get_reg(phandle, 0, &addr, &size) != 0) {
99 		aprint_error(": couldn't get registers\n");
100 		return;
101 	}
102 
103 	sc->sc_clk = fdtbus_clock_get_index(phandle, 0);
104 	if (sc->sc_clk == NULL) {
105 		aprint_error(": couldn't get clock\n");
106 		return;
107 	}
108 
109 	error = clk_enable(sc->sc_clk);
110 	if (error) {
111 		aprint_error_dev(sc->sc_dev, "couldn't enable: %d\n", error);
112 		return;
113 	}
114 
115 	aprint_naive("\n");
116 	aprint_normal(": On-Chip OTP Controller\n");
117 	if (bus_space_map(sc->sc_iot, addr, size, 0, &sc->sc_ioh)) {
118 		aprint_error_dev(self, "Cannot map registers\n");
119 		return;
120 	}
121 	ocotp_softc = sc;
122 	sc->sc_ios = size;
123 
124 	uint32_t v = imxocotp_read(OCOTP_VERSION);
125 	aprint_normal_dev(self, "OCOTP_VERSION %d.%d.%d\n", (v >> 24) & 0xff, (v >> 16) & 0xff, v & 0xffff);
126 
127 	return;
128 }
129 
130 uint32_t
imxocotp_read(uint32_t addr)131 imxocotp_read(uint32_t addr)
132 {
133 	struct imxocotp_softc *sc = ocotp_softc;
134 
135 	if (sc == NULL)
136 		return 0;
137 
138 	if (addr > sc->sc_ios)
139 		return 0;
140 
141 	return bus_space_read_4(sc->sc_iot, sc->sc_ioh, addr);
142 }
143