devtree.h File Reference

Devicetree bus. More...

#include <ipxe/device.h>
#include <ipxe/dma.h>
#include <ipxe/fdt.h>

Go to the source code of this file.

Data Structures
struct	dt_device
	A devicetree device. More...
struct	dt_driver
	A devicetree driver. More...

Macros
#define	DT_DRIVERS   __table ( struct dt_driver, "dt_drivers" )
	Devicetree driver table. More...
#define	__dt_driver   __table_entry ( DT_DRIVERS, 01 )
	Declare a devicetree driver. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
static void	dt_set_drvdata (struct dt_device *dt, void *priv)
	Set devicetree driver-private data. More...
static void *	dt_get_drvdata (struct dt_device *dt)
	Get devicetree driver-private data. More...
static struct dt_device *	dt_parent (struct dt_device *dt)
	Get devicetree parent device. More...
void *	dt_ioremap (struct dt_device *dt, unsigned int offset, unsigned int index, size_t len)
	Map devicetree range. More...
int	dt_probe_node (struct device *parent, unsigned int offset)
	Probe devicetree node. More...
void	dt_remove_node (struct device *parent)
	Remove devicetree node. More...
int	dt_probe_children (struct dt_device *parent, unsigned int offset)
	Probe devicetree children. More...
void	dt_remove_children (struct dt_device *parent)
	Remove devicetree children. More...

Detailed Description

Devicetree bus.

Definition in file devtree.h.

Macro Definition Documentation

DT_DRIVERS

#define DT_DRIVERS   __table ( struct dt_driver, "dt_drivers" )

Devicetree driver table.

Definition at line 55 of file devtree.h.

__dt_driver

struct dt_driver dwgpio_driver __dt_driver   __table_entry ( DT_DRIVERS, 01 )

Declare a devicetree driver.

DesignWare GPIO port devicetree driver.

Generic node driver.

Definition at line 58 of file devtree.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

dt_set_drvdata()

static void dt_set_drvdata ( struct dt_device *  dt, void *  priv  )

inlinestatic

Set devicetree driver-private data.

Parameters

dt	Devicetree device
priv	Private data

Definition at line 66 of file devtree.h.

                                                                       {
        dt->priv = priv;
}

References dt_device::priv, and priv.

Referenced by cgem_probe(), dwgpio_group_probe(), dwgpio_probe(), dwmac_probe(), dwuart_probe(), and dwusb_probe().

dt_get_drvdata()

static void* dt_get_drvdata ( struct dt_device *  dt )

inlinestatic

Get devicetree driver-private data.

Parameters

dt	Devicetree device

Return values

priv	Private data

Definition at line 76 of file devtree.h.

                                                             {
        return dt->priv;
}

References dt_device::priv.

Referenced by cgem_remove(), dwgpio_group_remove(), dwgpio_probe(), dwgpio_remove(), dwmac_remove(), dwuart_remove(), and dwusb_remove().

dt_parent()

static struct dt_device* dt_parent ( struct dt_device *  dt )

inlinestatic

Get devicetree parent device.

Parameters

dt	Devicetree device

Return values

parent

Parent devicetree device

Definition at line 86 of file devtree.h.

                                                                    {
        return container_of ( dt->dev.parent, struct dt_device, dev );
}

References container_of, dt_device::dev, and device::parent.

Referenced by dwgpio_probe().

dt_ioremap()

void* dt_ioremap	(	struct dt_device *	dt,
		unsigned int	offset,
		unsigned int	index,
		size_t	len
	)

Map devicetree range.

Parameters

dt	Devicetree device
offset	Starting node offset
index	Region index
len	Length to map, or 0 to map whole region

Return values

io_addr

I/O address, or NULL on error

Definition at line 52 of file devtree.c.

                                                     {
        struct fdt_reg_cells regs;
        uint64_t address;
        uint64_t size;
        void *io_addr;
        int rc;

        /* Get parent region cell size specification */
        if ( ( rc = fdt_parent_reg_cells ( &sysfdt, offset, &regs ) ) != 0 ) {
                DBGC ( dt, "DT %s could not get region cell sizes: %s\n",
                       dt->name, strerror ( rc ) );
                return NULL;
        }

        /* Read address */
        if ( ( rc = fdt_reg_address ( &sysfdt, offset, &regs, index,
                                      &address ) ) != 0 ) {
                DBGC ( dt, "DT %s could not read region %d address: %s\n",
                       dt->name, index, strerror ( rc ) );
                return NULL;
        }

        /* Read size (or assume sufficient, if tree specifies no sizes) */
        size = len;
        if ( regs.size_cells &&
             ( ( rc = fdt_reg_size ( &sysfdt, offset, &regs, index,
                                     &size ) ) != 0 ) ) {
                DBGC ( dt, "DT %s could not read region %d size: %s\n",
                       dt->name, index, strerror ( rc ) );
                return NULL;
        }

        /* Use region size as length if not specified */
        if ( ! len )
                len = size;
        DBGC ( dt, "DT %s region %d at %#08llx+%#04llx\n",
               dt->name, index, ( ( unsigned long long ) address ),
               ( ( unsigned long long ) size ) );

        /* Verify size */
        if ( len > size ) {
                DBGC ( dt, "DT %s region %d is too small (%#llx/%#zx bytes)\n",
                       dt->name, index, ( ( unsigned long long ) size ), len );
                return NULL;
        }

        /* Map region */
        io_addr = ioremap ( address, len );
        if ( ! io_addr ) {
                DBGC ( dt, "DT %s could not map region %d\n",
                       dt->name, index );
                return NULL;
        }

        return io_addr;
}

References address, DBGC, fdt_parent_reg_cells(), fdt_reg_address(), fdt_reg_size(), index, ioremap(), len, dt_device::name, NULL, offset, rc, regs, size, strerror(), and sysfdt.

Referenced by cgem_probe(), dwgpio_group_probe(), dwmac_probe(), dwuart_probe(), and dwusb_probe().

dt_probe_node()

int dt_probe_node	(	struct device *	parent,
		unsigned int	offset
	)

Probe devicetree node.

Parameters

parent	Parent generic device
offset	Starting node offset

Return values

rc	Return status code

Definition at line 196 of file devtree.c.

                                                                 {
        struct fdt_descriptor desc;
        struct dt_device *dt;
        const char *name;
        int rc;

        /* Describe token */
        if ( ( rc = fdt_describe ( &sysfdt, offset, &desc ) ) != 0 )
                goto err_describe;

        /* Allocate and initialise device */
        dt = zalloc ( sizeof ( *dt ) );
        if ( ! dt ) {
                rc = -ENOMEM;
                goto err_alloc;
        }
        name = ( offset ? desc.name : "root node" );
        dt->name = dt->dev.name;
        snprintf ( dt->dev.name, sizeof ( dt->dev.name ), "%s", name );
        dt->dev.desc.bus_type = BUS_TYPE_DT;
        dt->dev.desc.location = fdt_phandle ( &sysfdt, offset );
        dt->dev.parent = parent;
        INIT_LIST_HEAD ( &dt->dev.children );
        list_add_tail ( &dt->dev.siblings, &parent->children );

        /* Probe device */
        if ( ( rc = dt_probe ( dt, offset ) ) != 0 )
                goto err_probe;

        return 0;

        dt_remove ( dt );
 err_probe:
        list_del ( &dt->dev.siblings );
        free ( dt );
 err_alloc:
 err_describe:
        return rc;
}

References device_description::bus_type, BUS_TYPE_DT, device::children, desc, device::desc, dt_device::dev, dt_probe(), dt_remove(), ENOMEM, fdt_describe(), fdt_phandle(), free, INIT_LIST_HEAD, list_add_tail, list_del, device_description::location, dt_device::name, device::name, name, offset, device::parent, rc, device::siblings, snprintf(), sysfdt, and zalloc().

Referenced by dt_probe_all(), dt_probe_children(), and fdtcon_default().

dt_remove_node()

void dt_remove_node

(

struct device *

parent

)

Remove devicetree node.

Parameters

parent

Parent generic device

Definition at line 241 of file devtree.c.

                                              {
        struct dt_device *dt;

        /* Identify most recently added child */
        dt = list_last_entry ( &parent->children, struct dt_device,
                               dev.siblings );
        assert ( dt != NULL );

        /* Remove driver */
        dt_remove ( dt );

        /* Delete and free device */
        list_del ( &dt->dev.siblings );
        free ( dt );
}

References assert(), device::children, dt_device::dev, dt_remove(), free, list_del, list_last_entry, NULL, and device::siblings.

Referenced by dt_remove_all(), and dt_remove_children().

dt_probe_children()

int dt_probe_children	(	struct dt_device *	parent,
		unsigned int	offset
	)

Probe devicetree children.

Parameters

parent	Parent device
offset	Starting node offset

Return values

rc	Return status code

Definition at line 264 of file devtree.c.

                                                                        {
        struct fdt_descriptor desc;
        int depth;
        int rc;

        /* Probe any immediate child nodes */
        for ( depth = -1 ; ; depth += desc.depth, offset = desc.next ) {

                /* Describe token */
                if ( ( rc = fdt_describe ( &sysfdt, offset, &desc ) ) != 0 ) {
                        DBGC ( &sysfdt, "DT %s has malformed node: %s\n",
                               parent->name, strerror ( rc ) );
                        goto err_describe;
                }

                /* Terminate when we exit this node */
                if ( ( depth == 0 ) && ( desc.depth < 0 ) )
                        break;

                /* Probe child node, if applicable */
                if ( ( depth == 0 ) && desc.name && ( ! desc.data ) ) {
                        DBGC2 ( &sysfdt, "DT %s is child of %s\n",
                                desc.name, parent->name );
                        dt_probe_node ( &parent->dev, desc.offset );
                }
        }

        /* Fail if we have no children (so that this device will be freed) */
        if ( list_empty ( &parent->dev.children ) ) {
                rc = -ENODEV;
                goto err_no_children;
        }

        return 0;

 err_no_children:
 err_describe:
        dt_remove_children ( parent );
        return rc;
}

References device::children, DBGC, DBGC2, fdt_descriptor::depth, desc, dt_device::dev, dt_probe_node(), dt_remove_children(), ENODEV, fdt_describe(), list_empty, dt_device::name, offset, rc, strerror(), and sysfdt.

Referenced by dwgpio_group_probe().

dt_remove_children()

void dt_remove_children

(

struct dt_device *

parent

)

Remove devicetree children.

Parameters

parent

Parent device

Definition at line 310 of file devtree.c.

                                                     {

        /* Remove all child nodes */
        while ( ! list_empty ( &parent->dev.children ) )
                dt_remove_node ( &parent->dev );
}

References device::children, dt_device::dev, dt_remove_node(), and list_empty.

Referenced by dt_probe_children(), dwgpio_group_probe(), and dwgpio_group_remove().