soc/ti/ti_sci_protocol.h

1 // SPDX-License-Identifier: GPL-2.0
5  * Copyright (C) 2015-2016 Texas Instruments Incorporated - https://www.ti.com/
13  * struct ti_sci_version_info - version information structure
31  * struct ti_sci_core_ops - SoC Core Operations
41  * struct ti_sci_dev_ops - Device control operations
53  * @get_context_loss_count: Command to retrieve context loss counter - this
56  *		- count: pointer to u32 which will retrieve counter
60  *		- req_state: Returns requested idle state
65  *		- req_state: Returns requested stop state
66  *		- current_state: Returns current stop state
71  *		- req_state: Returns requested ON state
72  *		- current_state: Returns current ON state
78  *		-current_state: Returns 'true' if currently transitioning.
80  *		-reset_state: Device specific reset bit field
85  *		-reset_state: pointer to u32 which will retrieve resets
91  * -handle:	Pointer to TISCI handle as retrieved by *ti_sci_get_handle
92  * -id:		Device Identifier
94  * Request for the device - NOTE: the client MUST maintain integrity of
123  * struct ti_sci_clk_ops - Clock control operations
125  *		- needs_ssc: 'true' if Spread Spectrum clock is desired.
126  *		- can_change_freq: 'true' if frequency change is desired.
127  *		- enable_input_term: 'true' if input termination is desired.
131  *		- req_state: state indicating if the clock is auto managed
133  *		- req_state: if the clock is requested to be forced ON
134  *		- current_state: if the clock is currently ON
136  *		- req_state: if the clock is requested to be forced OFF
137  *		- current_state: if the clock is currently Gated
139  *		- parent_id: Parent clock identifier to set.
141  *		- parent_id: Parent clock identifier which is the parent.
143  *		- num_parents: returns the number of parent clocks.
146  *		- match_freq: Best matching frequency in Hz.
149  *		- current_freq: Frequency in Hz that the clock is at.
153  * -handle:	Pointer to TISCI handle as retrieved by *ti_sci_get_handle
154  * -did:	Device identifier this request is for
155  * -cid:	Clock identifier for the device for this request.
158  * -min_freq:	The minimum allowable frequency in Hz. This is the minimum
161  * -target_freq: The target clock frequency in Hz. A frequency will be
163  * -max_freq:	The maximum allowable frequency in Hz. This is the maximum
167  * Request for the clock - NOTE: the client MUST maintain integrity of
199  * struct ti_sci_resource_desc - Description of TI SCI resource instance range.
215  * struct ti_sci_rm_core_ops - Resource management core operations
219  *			- s_host: Host processing entity to which the
224  * - handle:	Pointer to TISCI handle as retrieved by *ti_sci_get_handle
225  * - dev_id:	TISCI device ID.
226  * - subtype:	Resource assignment subtype that is being requested
228  * - desc:	Pointer to ti_sci_resource_desc to be updated with the resource
292  * struct ti_sci_msg_rm_ring_cfg - Ring configuration
312  * struct ti_sci_rm_ringacc_ops - Ring Accelerator Management operations
321  * struct ti_sci_rm_psil_ops - PSI-L thread operations
322  * @pair: pair PSI-L source thread to a destination thread.
327  * @unpair: unpair PSI-L source thread from a destination thread.
487  * struct ti_sci_rm_udmap_ops - UDMA Management operations
502  * struct ti_sci_proc_ops - Processor Control operations
513  * -handle:	Pointer to TI SCI handle as retrieved by *ti_sci_get_handle
514  * -pid:	Processor ID
515  * -hid:	Host ID
531  * struct ti_sci_ops - Function support for TI SCI
551  * struct ti_sci_handle - Handle returned to TI SCI clients for usage.
563  * struct ti_sci_resource - Structure representing a resource assigned
597 	return ERR_PTR(-EINVAL);  in ti_sci_get_handle()
602 	return -EINVAL;  in ti_sci_put_handle()
608 	return ERR_PTR(-EINVAL);  in devm_ti_sci_get_handle()
615 	return ERR_PTR(-EINVAL);  in ti_sci_get_by_phandle()
622 	return ERR_PTR(-EINVAL);  in devm_ti_sci_get_by_phandle()
643 	return ERR_PTR(-EINVAL);  in devm_ti_sci_get_of_resource()
650 	return ERR_PTR(-EINVAL);  in devm_ti_sci_get_resource()