blob: f5e6cc1a4b1da9c284010d00eda9d00c54136eef [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass57251282015-06-23 15:38:43 -06002/*
3 * Copyright (c) 2015 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
Simon Glass57251282015-06-23 15:38:43 -06005 */
6
7#ifndef __SYSCON_H
8#define __SYSCON_H
9
Masahiro Yamadae151a1c2018-04-19 12:14:04 +090010#include <dm/ofnode.h>
Simon Glassc20ee0e2017-08-29 14:15:50 -060011#include <fdtdec.h>
12
Simon Glass57251282015-06-23 15:38:43 -060013/**
14 * struct syscon_uc_info - Information stored by the syscon UCLASS_UCLASS
15 *
16 * @regmap: Register map for this controller
17 */
18struct syscon_uc_info {
19 struct regmap *regmap;
20};
21
22/* So far there are no ops so this is a placeholder */
23struct syscon_ops {
24};
25
26#define syscon_get_ops(dev) ((struct syscon_ops *)(dev)->driver->ops)
27
Simon Glass04ecf362016-07-04 11:58:00 -060028#if CONFIG_IS_ENABLED(OF_PLATDATA)
29/*
30 * We don't support 64-bit machines. If they are so resource-contrained that
31 * they need to use OF_PLATDATA, something is horribly wrong with the
32 * education of our hardware engineers.
Simon Glassc20ee0e2017-08-29 14:15:50 -060033 *
34 * Update: 64-bit is now supported and we have an education crisis.
Simon Glass04ecf362016-07-04 11:58:00 -060035 */
Simon Glass8a8d24b2020-12-03 16:55:23 -070036struct syscon_base_plat {
Simon Glassc20ee0e2017-08-29 14:15:50 -060037 fdt_val_t reg[2];
Simon Glass04ecf362016-07-04 11:58:00 -060038};
39#endif
40
Simon Glass57251282015-06-23 15:38:43 -060041/**
42 * syscon_get_regmap() - Get access to a register map
43 *
44 * @dev: Device to check (UCLASS_SCON)
45 * @info: Returns regmap for the device
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010046 * Return: 0 if OK, -ve on error
Simon Glass57251282015-06-23 15:38:43 -060047 */
48struct regmap *syscon_get_regmap(struct udevice *dev);
49
50/**
51 * syscon_get_regmap_by_driver_data() - Look up a controller by its ID
52 *
53 * Each system controller can be accessed by its driver data, which is
54 * assumed to be unique through the scope of all system controllers that
Simon Glassac94b7b2016-01-17 16:11:08 -070055 * are in use. This function looks up the controller given this driver data.
56 *
57 * @driver_data: Driver data value to look up
58 * @devp: Returns the controller correponding to @driver_data
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010059 * Return: 0 on success, -ENODEV if the ID was not found, or other -ve error
Simon Glassac94b7b2016-01-17 16:11:08 -070060 * code
61 */
62int syscon_get_by_driver_data(ulong driver_data, struct udevice **devp);
63
64/**
65 * syscon_get_regmap_by_driver_data() - Look up a controller by its ID
66 *
67 * Each system controller can be accessed by its driver data, which is
68 * assumed to be unique through the scope of all system controllers that
Simon Glass57251282015-06-23 15:38:43 -060069 * are in use. This function looks up the regmap given this driver data.
70 *
71 * @driver_data: Driver data value to look up
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010072 * Return: register map correponding to @driver_data, or -ve error code
Simon Glass57251282015-06-23 15:38:43 -060073 */
74struct regmap *syscon_get_regmap_by_driver_data(ulong driver_data);
75
76/**
Jean-Jacques Hiblot6c3af1f2018-11-29 10:57:37 +010077 * syscon_regmap_lookup_by_phandle() - Look up a controller by a phandle
78 *
79 * This operates by looking up the given name in the device (device
80 * tree property) of the device using the system controller.
81 *
82 * @dev: Device using the system controller
83 * @name: Name of property referring to the system controller
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010084 * Return: A pointer to the regmap if found, ERR_PTR(-ve) on error
Jean-Jacques Hiblot6c3af1f2018-11-29 10:57:37 +010085 */
86struct regmap *syscon_regmap_lookup_by_phandle(struct udevice *dev,
87 const char *name);
88
89/**
Simon Glass57251282015-06-23 15:38:43 -060090 * syscon_get_first_range() - get the first memory range from a syscon regmap
91 *
92 * @driver_data: Driver data value to look up
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010093 * Return: first region of register map correponding to @driver_data, or
Simon Glass57251282015-06-23 15:38:43 -060094 * -ve error code
95 */
96void *syscon_get_first_range(ulong driver_data);
97
Masahiro Yamadae151a1c2018-04-19 12:14:04 +090098/**
99 * syscon_node_to_regmap - get regmap from syscon
100 *
101 * @node: Device node of syscon
102 */
103struct regmap *syscon_node_to_regmap(ofnode node);
104
Simon Glass57251282015-06-23 15:38:43 -0600105#endif