mirror of
https://github.com/AsahiLinux/u-boot
synced 2024-12-11 13:56:30 +00:00
4805a7af8e
This function returns -ENODEV when there is no device. This is inconsistent with other functions, such as uclass_find_next_device(), which returns 0. Update it and tidy up the incorrect '-1' values in the comments. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Bin Meng <bmeng.cn@gmail.com> Tested-by: Bin Meng <bmeng.cn@gmail.com>
254 lines
8 KiB
C
254 lines
8 KiB
C
/* SPDX-License-Identifier: GPL-2.0+ */
|
|
/*
|
|
* Copyright (c) 2013 Google, Inc
|
|
*
|
|
* (C) Copyright 2012
|
|
* Pavel Herrmann <morpheus.ibis@gmail.com>
|
|
*/
|
|
|
|
#ifndef _DM_UCLASS_INTERNAL_H
|
|
#define _DM_UCLASS_INTERNAL_H
|
|
|
|
#include <dm/ofnode.h>
|
|
|
|
/**
|
|
* uclass_find_next_free_req_seq() - Get the next free req_seq number
|
|
*
|
|
* This returns the next free req_seq number. This is useful only if
|
|
* OF_CONTROL is not used. The next free req_seq number is simply the
|
|
* maximum req_seq of the uclass + 1.
|
|
* This allows assiging req_seq number in the binding order.
|
|
*
|
|
* @id: Id number of the uclass
|
|
* @return The next free req_seq number
|
|
*/
|
|
int uclass_find_next_free_req_seq(enum uclass_id id);
|
|
|
|
/**
|
|
* uclass_get_device_tail() - handle the end of a get_device call
|
|
*
|
|
* This handles returning an error or probing a device as needed.
|
|
*
|
|
* @dev: Device that needs to be probed
|
|
* @ret: Error to return. If non-zero then the device is not probed
|
|
* @devp: Returns the value of 'dev' if there is no error
|
|
* @return ret, if non-zero, else the result of the device_probe() call
|
|
*/
|
|
int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp);
|
|
|
|
/**
|
|
* dev_get_uclass_index() - Get uclass and index of device
|
|
* @dev: - in - Device that we want the uclass/index of
|
|
* @ucp: - out - A pointer to the uclass the device belongs to
|
|
*
|
|
* The device is not prepared for use - this is an internal function.
|
|
*
|
|
* @return the index of the device in the uclass list or -ENODEV if not found.
|
|
*/
|
|
int dev_get_uclass_index(struct udevice *dev, struct uclass **ucp);
|
|
|
|
/**
|
|
* uclass_find_device() - Return n-th child of uclass
|
|
* @id: Id number of the uclass
|
|
* @index: Position of the child in uclass's list
|
|
* #devp: Returns pointer to device, or NULL on error
|
|
*
|
|
* The device is not prepared for use - this is an internal function.
|
|
* The function uclass_get_device_tail() can be used to probe the device.
|
|
*
|
|
* @return the uclass pointer of a child at the given index or
|
|
* return NULL on error.
|
|
*/
|
|
int uclass_find_device(enum uclass_id id, int index, struct udevice **devp);
|
|
|
|
/**
|
|
* uclass_find_first_device() - Return the first device in a uclass
|
|
* @id: Id number of the uclass
|
|
* #devp: Returns pointer to device, or NULL on error
|
|
*
|
|
* The device is not prepared for use - this is an internal function.
|
|
* The function uclass_get_device_tail() can be used to probe the device.
|
|
*
|
|
* @return 0 if OK (found or not found), -ve on error
|
|
*/
|
|
int uclass_find_first_device(enum uclass_id id, struct udevice **devp);
|
|
|
|
/**
|
|
* uclass_find_next_device() - Return the next device in a uclass
|
|
* @devp: On entry, pointer to device to lookup. On exit, returns pointer
|
|
* to the next device in the same uclass, or NULL if none
|
|
*
|
|
* The device is not prepared for use - this is an internal function.
|
|
* The function uclass_get_device_tail() can be used to probe the device.
|
|
*
|
|
* @return 0 if OK (found or not found), -ve on error
|
|
*/
|
|
int uclass_find_next_device(struct udevice **devp);
|
|
|
|
/**
|
|
* uclass_find_device_by_name() - Find uclass device based on ID and name
|
|
*
|
|
* This searches for a device with the exactly given name.
|
|
*
|
|
* The device is NOT probed, it is merely returned.
|
|
*
|
|
* @id: ID to look up
|
|
* @name: name of a device to find
|
|
* @devp: Returns pointer to device (the first one with the name)
|
|
* @return 0 if OK, -ve on error
|
|
*/
|
|
int uclass_find_device_by_name(enum uclass_id id, const char *name,
|
|
struct udevice **devp);
|
|
|
|
/**
|
|
* uclass_find_device_by_seq() - Find uclass device based on ID and sequence
|
|
*
|
|
* This searches for a device with the given seq or req_seq.
|
|
*
|
|
* For seq, if an active device has this sequence it will be returned.
|
|
* If there is no such device then this will return -ENODEV.
|
|
*
|
|
* For req_seq, if a device (whether activated or not) has this req_seq
|
|
* value, that device will be returned. This is a strong indication that
|
|
* the device will receive that sequence when activated.
|
|
*
|
|
* The device is NOT probed, it is merely returned.
|
|
*
|
|
* @id: ID to look up
|
|
* @seq_or_req_seq: Sequence number to find (0=first)
|
|
* @find_req_seq: true to find req_seq, false to find seq
|
|
* @devp: Returns pointer to device (there is only one per for each seq)
|
|
* @return 0 if OK, -ve on error
|
|
*/
|
|
int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq,
|
|
bool find_req_seq, struct udevice **devp);
|
|
|
|
/**
|
|
* uclass_find_device_by_of_offset() - Find a uclass device by device tree node
|
|
*
|
|
* This searches the devices in the uclass for one attached to the given
|
|
* device tree node.
|
|
*
|
|
* The device is NOT probed, it is merely returned.
|
|
*
|
|
* @id: ID to look up
|
|
* @node: Device tree offset to search for (if -ve then -ENODEV is returned)
|
|
* @devp: Returns pointer to device (there is only one for each node)
|
|
* @return 0 if OK, -ve on error
|
|
*/
|
|
int uclass_find_device_by_of_offset(enum uclass_id id, int node,
|
|
struct udevice **devp);
|
|
|
|
/**
|
|
* uclass_find_device_by_of_node() - Find a uclass device by device tree node
|
|
*
|
|
* This searches the devices in the uclass for one attached to the given
|
|
* device tree node.
|
|
*
|
|
* The device is NOT probed, it is merely returned.
|
|
*
|
|
* @id: ID to look up
|
|
* @node: Device tree offset to search for (if NULL then -ENODEV is returned)
|
|
* @devp: Returns pointer to device (there is only one for each node)
|
|
* @return 0 if OK, -ve on error
|
|
*/
|
|
int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node,
|
|
struct udevice **devp);
|
|
|
|
/**
|
|
* uclass_find_device_by_phandle() - Find a uclass device by phandle
|
|
*
|
|
* This searches the devices in the uclass for one with the given phandle.
|
|
*
|
|
* The device is NOT probed, it is merely returned.
|
|
*
|
|
* @id: ID to look up
|
|
* @parent: Parent device containing the phandle pointer
|
|
* @name: Name of property in the parent device node
|
|
* @devp: Returns pointer to device (there is only one for each node)
|
|
* @return 0 if OK, -ENOENT if there is no @name present in the node, other
|
|
* -ve on error
|
|
*/
|
|
int uclass_find_device_by_phandle(enum uclass_id id, struct udevice *parent,
|
|
const char *name, struct udevice **devp);
|
|
|
|
/**
|
|
* uclass_bind_device() - Associate device with a uclass
|
|
*
|
|
* Connect the device into uclass's list of devices.
|
|
*
|
|
* @dev: Pointer to the device
|
|
* #return 0 on success, -ve on error
|
|
*/
|
|
int uclass_bind_device(struct udevice *dev);
|
|
|
|
/**
|
|
* uclass_unbind_device() - Deassociate device with a uclass
|
|
*
|
|
* Disconnect the device from uclass's list of devices.
|
|
*
|
|
* @dev: Pointer to the device
|
|
* #return 0 on success, -ve on error
|
|
*/
|
|
#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
|
|
int uclass_unbind_device(struct udevice *dev);
|
|
#else
|
|
static inline int uclass_unbind_device(struct udevice *dev) { return 0; }
|
|
#endif
|
|
|
|
/**
|
|
* uclass_pre_probe_device() - Deal with a device that is about to be probed
|
|
*
|
|
* Perform any pre-processing that is needed by the uclass before it can be
|
|
* probed. This includes the uclass' pre-probe() method and the parent
|
|
* uclass' child_pre_probe() method.
|
|
*
|
|
* @dev: Pointer to the device
|
|
* #return 0 on success, -ve on error
|
|
*/
|
|
int uclass_pre_probe_device(struct udevice *dev);
|
|
|
|
/**
|
|
* uclass_post_probe_device() - Deal with a device that has just been probed
|
|
*
|
|
* Perform any post-processing of a probed device that is needed by the
|
|
* uclass.
|
|
*
|
|
* @dev: Pointer to the device
|
|
* #return 0 on success, -ve on error
|
|
*/
|
|
int uclass_post_probe_device(struct udevice *dev);
|
|
|
|
/**
|
|
* uclass_pre_remove_device() - Handle a device which is about to be removed
|
|
*
|
|
* Perform any pre-processing of a device that is about to be removed.
|
|
*
|
|
* @dev: Pointer to the device
|
|
* #return 0 on success, -ve on error
|
|
*/
|
|
#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
|
|
int uclass_pre_remove_device(struct udevice *dev);
|
|
#else
|
|
static inline int uclass_pre_remove_device(struct udevice *dev) { return 0; }
|
|
#endif
|
|
|
|
/**
|
|
* uclass_find() - Find uclass by its id
|
|
*
|
|
* @id: Id to serach for
|
|
* @return pointer to uclass, or NULL if not found
|
|
*/
|
|
struct uclass *uclass_find(enum uclass_id key);
|
|
|
|
/**
|
|
* uclass_destroy() - Destroy a uclass
|
|
*
|
|
* Destroy a uclass and all its devices
|
|
*
|
|
* @uc: uclass to destroy
|
|
* @return 0 on success, -ve on error
|
|
*/
|
|
int uclass_destroy(struct uclass *uc);
|
|
|
|
#endif
|