xref: /freebsd/sys/dev/fdt/fdt_pinctrl.h (revision 1c05a6ea6b849ff95e539c31adea887c644a6a01)
1 /*-
2  * Copyright (c) 2014 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 ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  * $FreeBSD$
26  */
27 
28 #ifndef DEV_FDT_PINCTRL_H
29 #define DEV_FDT_PINCTRL_H
30 
31 #include "fdt_pinctrl_if.h"
32 
33 /*
34  * Configure pins by name or index.  This looks up the pinctrl-N property in
35  * client's fdt data by index or name, and passes each handle in it to the
36  * pinctrl driver for configuration.
37  */
38 int fdt_pinctrl_configure(device_t client, u_int index);
39 int fdt_pinctrl_configure_by_name(device_t client, const char * name);
40 
41 /*
42  * Register a pinctrl driver so that it can be used by other devices which call
43  * fdt_pinctrl_configure().  The pinprop argument is the name of a property that
44  * identifies each descendent of the pinctrl node which is a pin configuration
45  * node whose xref phandle can be passed to FDT_PINCTRL_CONFIGURE().  If this is
46  * NULL, every descendant node is registered.
47  */
48 int fdt_pinctrl_register(device_t pinctrl, const char *pinprop);
49 
50 /*
51  * Walk the device tree and configure pins for each enabled device whose
52  * pinctrl-0 property contains references to nodes which are children of the
53  * given pinctrl device.  This helper routine is for use by pinctrl drivers.
54  */
55 int fdt_pinctrl_configure_tree(device_t pinctrl);
56 
57 #endif /* DEV_FDT_PINCTRL_H */
58 
59