dm: core: Add a command to show driver model statistics
[platform/kernel/u-boot.git] / drivers / core / Kconfig
1 menu "Generic Driver Options"
2
3 config DM
4         bool "Enable Driver Model"
5         help
6           This config option enables Driver Model. This brings in the core
7           support, including scanning of platform data on start-up. If
8           CONFIG_OF_CONTROL is enabled, the device tree will be scanned also
9           when available.
10
11 config SPL_DM
12         bool "Enable Driver Model for SPL"
13         depends on DM && SPL
14         help
15           Enable driver model in SPL. You will need to provide a
16           suitable malloc() implementation. If you are not using the
17           full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
18           consider using CONFIG_SPL_SYS_MALLOC_SIMPLE. In that case you
19           must provide CONFIG_SPL_SYS_MALLOC_F_LEN to set the size.
20           In most cases driver model will only allocate a few uclasses
21           and devices in SPL, so 1KB should be enable. See
22           CONFIG_SPL_SYS_MALLOC_F_LEN for more details on how to enable it.
23
24 config TPL_DM
25         bool "Enable Driver Model for TPL"
26         depends on DM && TPL
27         help
28           Enable driver model in TPL. You will need to provide a
29           suitable malloc() implementation. If you are not using the
30           full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
31           consider using CONFIG_TPL_SYS_MALLOC_SIMPLE. In that case you
32           must provide CONFIG_SPL_SYS_MALLOC_F_LEN to set the size.
33           In most cases driver model will only allocate a few uclasses
34           and devices in SPL, so 1KB should be enough. See
35           CONFIG_SPL_SYS_MALLOC_F_LEN for more details on how to enable it.
36           Disable this for very small implementations.
37
38 config VPL_DM
39         bool "Enable Driver Model for VPL"
40         depends on DM && VPL
41         default y if SPL_DM
42         help
43           Enable driver model in VPL. You will need to provide a
44           suitable malloc() implementation. If you are not using the
45           full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
46           consider using CONFIG_SPL_SYS_MALLOC_SIMPLE.
47
48 config DM_WARN
49         bool "Enable warnings in driver model"
50         depends on DM
51         default y
52         help
53           Enable this to see warnings related to driver model.
54
55           Warnings may help with debugging, such as when expected devices do
56           not bind correctly. If the option is disabled, dm_warn() is compiled
57           out - it will do nothing when called.
58
59 config SPL_DM_WARN
60         bool "Enable warnings in driver model wuth SPL"
61         depends on SPL_DM
62         help
63           Enable this to see warnings related to driver model in SPL
64
65           The dm_warn() function can use up quite a bit of space for its
66           strings. By default this is disabled for SPL builds to save space.
67
68           Warnings may help with debugging, such as when expected devices do
69           not bind correctly. If the option is disabled, dm_warn() is compiled
70           out - it will do nothing when called.
71
72 config DM_DEBUG
73         bool "Enable debug messages in driver model core"
74         depends on DM
75         help
76           Say Y here if you want to compile in debug messages in DM core.
77
78 config DM_STATS
79         bool "Collect and show driver model stats"
80         depends on DM
81         default y if SANDBOX
82         help
83           Enable this to collect and display memory statistics about driver
84           model. This can help to figure out where all the memory is going and
85           to find optimisations.
86
87           To display the memory stats, use the 'dm mem' command.
88
89 config DM_DEVICE_REMOVE
90         bool "Support device removal"
91         depends on DM
92         default y
93         help
94           We can save some code space by dropping support for removing a
95           device.
96
97           Note that this may have undesirable results in the USB subsystem as
98           it causes unplugged devices to linger around in the dm-tree, and it
99           causes USB host controllers to not be stopped when booting the OS.
100
101 config DM_EVENT
102         bool "Support events with driver model"
103         depends on DM && EVENT
104         default y if SANDBOX
105         help
106           This enables support for generating events related to driver model
107           operations, such as prbing or removing a device. Subsystems can
108           register a 'spy' function that is called when the event occurs.
109
110 config SPL_DM_DEVICE_REMOVE
111         bool "Support device removal in SPL"
112         depends on SPL_DM
113         help
114           We can save some code space by dropping support for removing a
115           device. This is not normally required in SPL, so by default this
116           option is disabled for SPL.
117
118 config DM_STDIO
119         bool "Support stdio registration"
120         depends on DM
121         default y
122         help
123           Normally serial drivers register with stdio so that they can be used
124           as normal output devices. In SPL we don't normally use stdio, so
125           we can omit this feature.
126
127 config DM_SEQ_ALIAS
128         bool "Support numbered aliases in device tree"
129         depends on DM
130         default y
131         help
132           Most boards will have a '/aliases' node containing the path to
133           numbered devices (e.g. serial0 = &serial0). This feature can be
134           disabled if it is not required.
135
136 config SPL_DM_SEQ_ALIAS
137         bool "Support numbered aliases in device tree in SPL"
138         depends on SPL_DM
139         help
140           Most boards will have a '/aliases' node containing the path to
141           numbered devices (e.g. serial0 = &serial0). This feature can be
142           disabled if it is not required, to save code space in SPL.
143
144 config VPL_DM_SEQ_ALIAS
145         bool "Support numbered aliases in device tree in VPL"
146         depends on VPL_DM
147         default y
148         help
149           Most boards will have a '/aliases' node containing the path to
150           numbered devices (e.g. serial0 = &serial0). This feature can be
151           disabled if it is not required, to save code space in VPL.
152
153 config SPL_DM_INLINE_OFNODE
154         bool "Inline some ofnode functions which are seldom used in SPL"
155         depends on SPL_DM
156         default y
157         help
158           This applies to several ofnode functions (see ofnode.h) which are
159           seldom used. Inlining them can help reduce code size.
160
161 config TPL_DM_INLINE_OFNODE
162         bool "Inline some ofnode functions which are seldom used in TPL"
163         depends on TPL_DM
164         default y
165         help
166           This applies to several ofnode functions (see ofnode.h) which are
167           seldom used. Inlining them can help reduce code size.
168
169 config DM_DMA
170         bool "Support per-device DMA constraints"
171         depends on DM
172         help
173           Enable this to extract per-device DMA constraints, only supported on
174           device-tree systems for now. This is needed in order translate
175           addresses on systems where different buses have different views of
176           the physical address space.
177
178 config REGMAP
179         bool "Support register maps"
180         depends on DM
181         help
182           Hardware peripherals tend to have one or more sets of registers
183           which can be accessed to control the hardware. A register map
184           models this with a simple read/write interface. It can in principle
185           support any bus type (I2C, SPI) but so far this only supports
186           direct memory access.
187
188 config SPL_REGMAP
189         bool "Support register maps in SPL"
190         depends on SPL_DM
191         help
192           Hardware peripherals tend to have one or more sets of registers
193           which can be accessed to control the hardware. A register map
194           models this with a simple read/write interface. It can in principle
195           support any bus type (I2C, SPI) but so far this only supports
196           direct memory access.
197
198 config TPL_REGMAP
199         bool "Support register maps in TPL"
200         depends on TPL_DM
201         help
202           Hardware peripherals tend to have one or more sets of registers
203           which can be accessed to control the hardware. A register map
204           models this with a simple read/write interface. It can in principle
205           support any bus type (I2C, SPI) but so far this only supports
206           direct memory access.
207
208 config VPL_REGMAP
209         bool "Support register maps in VPL"
210         depends on VPL_DM
211         help
212           Hardware peripherals tend to have one or more sets of registers
213           which can be accessed to control the hardware. A register map
214           models this with a simple read/write interface. It can in principle
215           support any bus type (I2C, SPI) but so far this only supports
216           direct memory access.
217
218 config SYSCON
219         bool "Support system controllers"
220         depends on REGMAP
221         help
222           Many SoCs have a number of system controllers which are dealt with
223           as a group by a single driver. Some common functionality is provided
224           by this uclass, including accessing registers via regmap and
225           assigning a unique number to each.
226
227 config SPL_SYSCON
228         bool "Support system controllers in SPL"
229         depends on SPL_REGMAP
230         help
231           Many SoCs have a number of system controllers which are dealt with
232           as a group by a single driver. Some common functionality is provided
233           by this uclass, including accessing registers via regmap and
234           assigning a unique number to each.
235
236 config TPL_SYSCON
237         bool "Support system controllers in TPL"
238         depends on SPL_REGMAP
239         help
240           Many SoCs have a number of system controllers which are dealt with
241           as a group by a single driver. Some common functionality is provided
242           by this uclass, including accessing registers via regmap and
243           assigning a unique number to each.
244
245 config VPL_SYSCON
246         bool "Support system controllers in VPL"
247         depends on VPL_REGMAP
248         help
249           Many SoCs have a number of system controllers which are dealt with
250           as a group by a single driver. Some common functionality is provided
251           by this uclass, including accessing registers via regmap and
252           assigning a unique number to each.
253
254 config DEVRES
255         bool "Managed device resources"
256         depends on DM
257         help
258           This option enables the Managed device resources core support.
259           Device resources managed by the devres framework are automatically
260           released whether initialization fails half-way or the device gets
261           detached.
262
263           If this option is disabled, devres functions fall back to
264           non-managed variants.  For example, devres_alloc() to kzalloc(),
265           devm_kmalloc() to kmalloc(), etc.
266
267 config DEBUG_DEVRES
268         bool "Managed device resources debugging functions"
269         depends on DEVRES
270         help
271           If this option is enabled, devres debug messages are printed.
272           Also, a function is available to dump a list of device resources.
273           Select this if you are having a problem with devres or want to
274           debug resource management for a managed device.
275
276           If you are unsure about this, Say N here.
277
278 config SIMPLE_BUS
279         bool "Support simple-bus driver"
280         depends on DM && OF_CONTROL
281         default y
282         help
283           Supports the 'simple-bus' driver, which is used on some systems.
284
285 config SPL_SIMPLE_BUS
286         bool "Support simple-bus driver in SPL"
287         depends on SPL_DM && SPL_OF_CONTROL
288         default y
289         help
290           Supports the 'simple-bus' driver, which is used on some systems
291           in SPL.
292
293 config SIMPLE_BUS_CORRECT_RANGE
294         bool "Decode the 'simple-bus' <range> by honoring the #address-cells and #size-cells"
295         depends on SIMPLE_BUS
296         default y if SANDBOX
297         help
298           Decoding the 'simple-bus' <range> by honoring the #address-cells
299           and #size-cells of parent/child bus. If unset, #address-cells of
300           parent bus is assumed to be 1, #address-cells and #size-cells of
301           child bus is also assumed to be 1, to save some spaces of using
302           an advanced API to decode the <range>, which benefits SPL image
303           builds that have size limits.
304
305           If you are unsure about this, Say N here.
306
307 config SIMPLE_PM_BUS
308         bool "Support simple-pm-bus driver"
309         depends on DM && OF_CONTROL && CLK && POWER_DOMAIN
310         help
311           Supports the 'simple-pm-bus' driver, which is used for busses that
312           have power domains and/or clocks which need to be enabled before use.
313
314 config OF_TRANSLATE
315         bool "Translate addresses using fdt_translate_address"
316         depends on DM && OF_CONTROL
317         default y
318         help
319           If this option is enabled, the reg property will be translated
320           using the fdt_translate_address() function. This is necessary
321           on some platforms (e.g. MVEBU) using complex "ranges"
322           properties in many nodes. As this translation is not handled
323           correctly in the default simple_bus_translate() function.
324
325           If this option is not enabled, simple_bus_translate() will be
326           used for the address translation. This function is faster and
327           smaller in size than fdt_translate_address().
328
329 config SPL_OF_TRANSLATE
330         bool "Translate addresses using fdt_translate_address in SPL"
331         depends on SPL_DM && SPL_OF_CONTROL
332         help
333           If this option is enabled, the reg property will be translated
334           using the fdt_translate_address() function. This is necessary
335           on some platforms (e.g. MVEBU) using complex "ranges"
336           properties in many nodes. As this translation is not handled
337           correctly in the default simple_bus_translate() function.
338
339           If this option is not enabled, simple_bus_translate() will be
340           used for the address translation. This function is faster and
341           smaller in size than fdt_translate_address().
342
343 config VPL_OF_TRANSLATE
344         bool "Translate addresses using fdt_translate_address in SPL"
345         depends on SPL_DM && VPL_OF_CONTROL
346         help
347           If this option is enabled, the reg property will be translated
348           using the fdt_translate_address() function. This is necessary
349           on some platforms (e.g. MVEBU) using complex "ranges"
350           properties in many nodes. As this translation is not handled
351           correctly in the default simple_bus_translate() function.
352
353           If this option is not enabled, simple_bus_translate() will be
354           used for the address translation. This function is faster and
355           smaller in size than fdt_translate_address().
356
357 config TRANSLATION_OFFSET
358         bool "Platforms specific translation offset"
359         depends on DM && OF_CONTROL
360         help
361           Some platforms need a special address translation. Those
362           platforms (e.g. mvebu in SPL) can configure a translation
363           offset by enabling this option and setting the translation_offset
364           variable in the GD in their platform- / board-specific code.
365
366 config OF_ISA_BUS
367         bool
368         depends on OF_TRANSLATE
369         help
370           Is this option is enabled then support for the ISA bus will
371           be included for addresses read from DT. This is something that
372           should be known to be required or not based upon the board
373           being targeted, and whether or not it makes use of an ISA bus.
374
375           The bus is matched based upon its node name equalling "isa". The
376           busses #address-cells should equal 2, with the first cell being
377           used to hold flags & flag 0x1 indicating that the address range
378           should be accessed using I/O port in/out accessors. The second
379           cell holds the offset into ISA bus address space. The #size-cells
380           property should equal 1, and of course holds the size of the
381           address range used by a device.
382
383           If this option is not enabled then support for the ISA bus is
384           not included and any such busses used in DT will be treated as
385           typical simple-bus compatible busses. This will lead to
386           mistranslation of device addresses, so ensure that this is
387           enabled if your board does include an ISA bus.
388
389 config DM_DEV_READ_INLINE
390         bool
391         default y if !OF_LIVE
392
393 config ACPIGEN
394         bool "Support ACPI table generation in driver model"
395         default y if SANDBOX || (GENERATE_ACPI_TABLE && !QEMU)
396         select LIB_UUID
397         help
398           This option enables generation of ACPI tables using driver-model
399           devices. It adds a new operation struct to each driver, to support
400           things like generating device-specific tables and returning the ACPI
401           name of a device.
402
403 config BOUNCE_BUFFER
404         bool "Include bounce buffer API"
405         help
406           Some peripherals support DMA from a subset of physically
407           addressable memory only.  To support such peripherals, the
408           bounce buffer API uses a temporary buffer: it copies data
409           to/from DMA regions while managing cache operations.
410
411           A second possible use of bounce buffers is their ability to
412           provide aligned buffers for DMA operations.
413
414 endmenu