bindings.Binding Class Reference

This class represent a binding document. More...

Public Member Functions
def	get_prop_by_name (self, name)
	The clean way to retrieve a property from BindingProps. More...
def	required (self)
	The clean way to retrieve BindingProps._required. More...
def	optional (self)
	The clean way to retrieve BindingProps._optional. More...

Public Attributes
	file_name
	id
	schema
	maintainers
	title
	examples

Private Member Functions
def	_init_allOf (self)
	Init _refs.
def	_init_Properties (self)
	Init _props which is basically a BindingProps item. More...

Private Attributes
	_verbose
	_path
	_files_dict
	_content
	_file
	_refs
	_if
	_props

Detailed Description

This class represent a binding document.

Member Function Documentation

_init_Properties()

def bindings.Binding._init_Properties (   self )

private

Init _props which is basically a BindingProps item.

Exctract required list from _content and call BindingProps.add_required() function

get_prop_by_name()

def bindings.Binding.get_prop_by_name	(		self,
			name
	)

The clean way to retrieve a property from BindingProps.

Parameters

name	Name of the desired props

Returns

A Prop item or None

optional()

def bindings.Binding.optional

(

self

)

The clean way to retrieve BindingProps._optional.

Returns

BindingProps._optional

required()

def bindings.Binding.required

(

self

)

The clean way to retrieve BindingProps._required.

Returns

BindingProps._required

Member Data Documentation

_content

bindings.Binding._content

private

Internal pointer on loaded yaml

_file

bindings.Binding._file

private

Internal file pointer

_files_dict

bindings.Binding._files_dict

private

Internal reference on all YAML path in root dir. Given by SDTBindings

_if

bindings.Binding._if

private

Internal reference on if node from allOf node (currently unused)

_path

bindings.Binding._path

private

Internal reference for path of the main file

_props

bindings.Binding._props

private

Internal reference on BindingProps containing properties information

_refs

bindings.Binding._refs

private

Internal reference on Binding included by $ref in allOf node

_verbose

def bindings.Binding._verbose

private

Internal reference for printing debug level (0 to 3)

examples

bindings.Binding.examples

If maintainers did some, you can find dts node examples here

file_name

bindings.Binding.file_name

The YAML file name represented by this class

id

bindings.Binding.id

Usually kernel.org link to this binding

maintainers

bindings.Binding.maintainers

Maintainers of this bindings

schema

bindings.Binding.schema

dt-schema used as base for this binding

title

bindings.Binding.title

Title of this bindings

---

The documentation for this class was generated from the following file:

• bindings.py