mirror of
https://github.com/brain-hackers/u-boot-brain
synced 2024-07-06 11:16:15 +09:00
3c14083f20
The current documentation for this is not particularly enlightening. Add a little more detail. Signed-off-by: Simon Glass <sjg@chromium.org>
76 lines
2.4 KiB
C
76 lines
2.4 KiB
C
/* SPDX-License-Identifier: GPL-2.0+ */
|
|
/*
|
|
* Copyright (c) 2013 Google, Inc
|
|
*
|
|
* (C) Copyright 2012
|
|
* Pavel Herrmann <morpheus.ibis@gmail.com>
|
|
* Marek Vasut <marex@denx.de>
|
|
*/
|
|
|
|
#ifndef _DM_PLATDATA_H
|
|
#define _DM_PLATDATA_H
|
|
|
|
#include <linker_lists.h>
|
|
|
|
/**
|
|
* struct driver_info - Information required to instantiate a device
|
|
*
|
|
* NOTE: Avoid using this except in extreme circumstances, where device tree
|
|
* is not feasible (e.g. serial driver in SPL where <8KB of SRAM is
|
|
* available). U-Boot's driver model uses device tree for configuration.
|
|
*
|
|
* @name: Driver name
|
|
* @platdata: Driver-specific platform data
|
|
* @platdata_size: Size of platform data structure
|
|
* @dev: Device created from this structure data
|
|
*/
|
|
struct driver_info {
|
|
const char *name;
|
|
const void *platdata;
|
|
#if CONFIG_IS_ENABLED(OF_PLATDATA)
|
|
uint platdata_size;
|
|
struct udevice *dev;
|
|
#endif
|
|
};
|
|
|
|
/**
|
|
* NOTE: Avoid using these except in extreme circumstances, where device tree
|
|
* is not feasible (e.g. serial driver in SPL where <8KB of SRAM is
|
|
* available). U-Boot's driver model uses device tree for configuration.
|
|
*/
|
|
#define U_BOOT_DEVICE(__name) \
|
|
ll_entry_declare(struct driver_info, __name, driver_info)
|
|
|
|
/* Declare a list of devices. The argument is a driver_info[] array */
|
|
#define U_BOOT_DEVICES(__name) \
|
|
ll_entry_declare_list(struct driver_info, __name, driver_info)
|
|
|
|
/**
|
|
* Get a pointer to a given device info given its name
|
|
*
|
|
* With the declaration U_BOOT_DEVICE(name), DM_GET_DEVICE(name) will return a
|
|
* pointer to the struct driver_info created by that declaration.
|
|
*
|
|
* if OF_PLATDATA is enabled, from this it is possible to use the @dev member of
|
|
* struct driver_info to find the device pointer itself.
|
|
*
|
|
* TODO(sjg@chromium.org): U_BOOT_DEVICE() tells U-Boot to create a device, so
|
|
* the naming seems sensible, but DM_GET_DEVICE() is a bit of misnomer, since it
|
|
* finds the driver_info record, not the device.
|
|
*
|
|
* @__name: Driver name (C identifier, not a string. E.g. gpio7_at_ff7e0000)
|
|
* @return struct driver_info * to the driver that created the device
|
|
*/
|
|
#define DM_GET_DEVICE(__name) \
|
|
ll_entry_get(struct driver_info, __name, driver_info)
|
|
|
|
/**
|
|
* dm_populate_phandle_data() - Populates phandle data in platda
|
|
*
|
|
* This populates phandle data with an U_BOOT_DEVICE entry get by
|
|
* DM_GET_DEVICE. The implementation of this function will be done
|
|
* by dtoc when parsing dtb.
|
|
*/
|
|
void dm_populate_phandle_data(void);
|
|
#endif
|