xref: /freebsd/sys/arm/freescale/imx/imx_machdep.h (revision 0782240958117692ab9861abb5483c9e64f6bc39)
1 /*-
2  * Copyright (c) 2013 Ian Lepore <ian@freebsd.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  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef	IMX_MACHDEP_H
30 #define	IMX_MACHDEP_H
31 
32 #include <sys/types.h>
33 
34 /* Common functions, implemented in imx_machdep.c. */
35 
36 void imx_devmap_addentry(vm_paddr_t _pa, vm_size_t _sz);
37 void imx_wdog_cpu_reset(vm_offset_t _wdcr_phys)  __attribute__((__noreturn__));
38 
39 /* From here down, routines are implemented in imxNN_machdep.c. */
40 
41 /*
42  * SoC identity.
43  * According to the documentation, there is such a thing as an i.MX6 Dual
44  * (non-lite flavor).  However, Freescale doesn't seem to have assigned it a
45  * number in their code for determining the SoC type in u-boot.
46  *
47  * To-do: put silicon revision numbers into the low-order bits somewhere.
48  */
49 #define	IMXSOC_51	0x51000000
50 #define	IMXSOC_53	0x53000000
51 #define	IMXSOC_6SL	0x60000000
52 #define	IMXSOC_6DL	0x61000000
53 #define	IMXSOC_6S	0x62000000
54 #define	IMXSOC_6Q	0x63000000
55 #define	IMXSOC_FAMSHIFT	28
56 
57 u_int imx_soc_type(void);
58 u_int imx_soc_family(void);
59 
60 void imx_devmap_init(void);
61 
62 /*
63  * We need a clock management system that works across unrelated SoCs and
64  * devices.  For now, to keep imx development moving, define some barebones
65  * functionality that can be shared within the imx family by having each SoC
66  * implement functions with a common name.
67  *
68  * The usb enable functions are best-effort.  They turn on the usb otg, host,
69  * and phy clocks in a SoC-specific manner, but it may take a lot more than that
70  * to make usb work on a given board.  In particular, it can require specific
71  * pinmux setup of gpio pins connected to external phy parts, voltage regulators
72  * and overcurrent detectors, and so on.  On such boards, u-boot or other early
73  * board setup code has to handle those things.
74  */
75 void imx_ccm_usb_enable(device_t _usbdev);
76 void imx_ccm_usbphy_enable(device_t _phydev);
77 
78 #endif
79 
80