1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 /* 3 * Copyright (c) 2013 Google, Inc 4 * 5 * (C) Copyright 2012 6 * Pavel Herrmann <morpheus.ibis@gmail.com> 7 * Marek Vasut <marex@denx.de> 8 */ 9 10 #ifndef _DM_PLATDATA_H 11 #define _DM_PLATDATA_H 12 13 #include <linker_lists.h> 14 15 /** 16 * struct driver_info - Information required to instantiate a device 17 * 18 * NOTE: Avoid using this except in extreme circumstances, where device tree 19 * is not feasible (e.g. serial driver in SPL where <8KB of SRAM is 20 * available). U-Boot's driver model uses device tree for configuration. 21 * 22 * @name: Driver name 23 * @plat: Driver-specific platform data 24 * @plat_size: Size of platform data structure 25 * @parent_idx: Index of the parent driver_info structure 26 */ 27 struct driver_info { 28 const char *name; 29 const void *plat; 30 #if CONFIG_IS_ENABLED(OF_PLATDATA) 31 unsigned short plat_size; 32 short parent_idx; 33 #endif 34 }; 35 36 #if CONFIG_IS_ENABLED(OF_PLATDATA) 37 #define driver_info_parent_id(driver_info) driver_info->parent_idx 38 #else 39 #define driver_info_parent_id(driver_info) (-1) 40 #endif 41 42 /** 43 * driver_rt - runtime information set up by U-Boot 44 * 45 * There is one of these for every driver_info in the linker list, indexed by 46 * the driver_info idx value. 47 * 48 * @dev: Device created from this idx 49 */ 50 struct driver_rt { 51 struct udevice *dev; 52 }; 53 54 /** 55 * NOTE: Avoid using these except in extreme circumstances, where device tree 56 * is not feasible (e.g. serial driver in SPL where <8KB of SRAM is 57 * available). U-Boot's driver model uses device tree for configuration. 58 * 59 * When of-platdata is in use, U_BOOT_DRVINFO() cannot be used outside of the 60 * dt-plat.c file created by dtoc 61 */ 62 #if CONFIG_IS_ENABLED(OF_PLATDATA) && !defined(DT_PLAT_C) 63 #define U_BOOT_DRVINFO(__name) _Static_assert(false, \ 64 "Cannot use U_BOOT_DRVINFO with of-platdata. Please use devicetree instead") 65 #else 66 #define U_BOOT_DRVINFO(__name) \ 67 ll_entry_declare(struct driver_info, __name, driver_info) 68 #endif 69 70 /* Declare a list of devices. The argument is a driver_info[] array */ 71 #define U_BOOT_DRVINFOS(__name) \ 72 ll_entry_declare_list(struct driver_info, __name, driver_info) 73 74 /** 75 * Get a pointer to a given device info given its name 76 * 77 * With the declaration U_BOOT_DRVINFO(name), DM_DRVINFO_GET(name) will return a 78 * pointer to the struct driver_info created by that declaration. 79 * 80 * if OF_PLATDATA is enabled, from this it is possible to use the @dev member of 81 * struct driver_info to find the device pointer itself. 82 * 83 * @__name: Driver name (C identifier, not a string. E.g. gpio7_at_ff7e0000) 84 * @return struct driver_info * to the driver that created the device 85 */ 86 #define DM_DRVINFO_GET(__name) \ 87 ll_entry_get(struct driver_info, __name, driver_info) 88 89 #endif 90