hc
2025-02-14 bbb9540dc49f70f6b703d1c8d1b85fa5f602d86e
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/*
 * Copyright (c) 2015 Google, Inc
 * Written by Simon Glass <sjg@chromium.org>
 *
 * SPDX-License-Identifier:    GPL-2.0+
 */
 
#ifndef __SYSCON_H
#define __SYSCON_H
 
#include <fdtdec.h>
 
/**
 * struct syscon_uc_info - Information stored by the syscon UCLASS_UCLASS
 *
 * @regmap:    Register map for this controller
 */
struct syscon_uc_info {
   struct regmap *regmap;
};
 
/* So far there are no ops so this is a placeholder */
struct syscon_ops {
};
 
#define syscon_get_ops(dev)        ((struct syscon_ops *)(dev)->driver->ops)
 
#if CONFIG_IS_ENABLED(OF_PLATDATA)
/*
 * We don't support 64-bit machines. If they are so resource-contrained that
 * they need to use OF_PLATDATA, something is horribly wrong with the
 * education of our hardware engineers.
 *
 * Update: 64-bit is now supported and we have an education crisis.
 */
struct syscon_base_platdata {
   fdt_val_t reg[2];
};
#endif
 
/**
 * syscon_get_regmap() - Get access to a register map
 *
 * @dev:    Device to check (UCLASS_SCON)
 * @info:    Returns regmap for the device
 * @return 0 if OK, -ve on error
 */
struct regmap *syscon_get_regmap(struct udevice *dev);
 
/**
 * syscon_get_regmap_by_driver_data() - Look up a controller by its ID
 *
 * Each system controller can be accessed by its driver data, which is
 * assumed to be unique through the scope of all system controllers that
 * are in use. This function looks up the controller given this driver data.
 *
 * @driver_data:    Driver data value to look up
 * @devp:        Returns the controller correponding to @driver_data
 * @return 0 on success, -ENODEV if the ID was not found, or other -ve error
 *       code
 */
int syscon_get_by_driver_data(ulong driver_data, struct udevice **devp);
 
/**
 * syscon_get_regmap_by_driver_data() - Look up a controller by its ID
 *
 * Each system controller can be accessed by its driver data, which is
 * assumed to be unique through the scope of all system controllers that
 * are in use. This function looks up the regmap given this driver data.
 *
 * @driver_data:    Driver data value to look up
 * @return register map correponding to @driver_data, or -ve error code
 */
struct regmap *syscon_get_regmap_by_driver_data(ulong driver_data);
 
/**
 * syscon_regmap_lookup_by_phandle() - Look up a controller by a phandle
 *
 * This operates by looking up the given name in the device (device
 * tree property) of the device using the system controller.
 *
 * @dev:    Device using the system controller
 * @name:    Name of property referring to the system controller
 * @return    A pointer to the regmap if found, ERR_PTR(-ve) on error
 */
struct regmap *syscon_regmap_lookup_by_phandle(struct udevice *dev,
                          const char *name);
 
/**
 * syscon_get_first_range() - get the first memory range from a syscon regmap
 *
 * @driver_data:    Driver data value to look up
 * @return first region of register map correponding to @driver_data, or
 *            -ve error code
 */
void *syscon_get_first_range(ulong driver_data);
 
#endif