// SPDX-License-Identifier: GPL-2.0 /* * Texas Instruments System Control Interface Protocol * * Copyright (C) 2015-2016 Texas Instruments Incorporated - https://www.ti.com/ * Nishanth Menon */ #ifndef __TISCI_PROTOCOL_H #define __TISCI_PROTOCOL_H /** * struct ti_sci_version_info - version information structure * @abi_major: Major ABI version. Change here implies risk of backward * compatibility break. * @abi_minor: Minor ABI version. Change here implies new feature addition, * or compatible change in ABI. * @firmware_revision: Firmware revision (not usually used). * @firmware_description: Firmware description (not usually used). */ struct ti_sci_version_info { … }; struct ti_sci_handle; /** * struct ti_sci_core_ops - SoC Core Operations * @reboot_device: Reboot the SoC * Returns 0 for successful request(ideally should never return), * else returns corresponding error value. */ struct ti_sci_core_ops { … }; /** * struct ti_sci_dev_ops - Device control operations * @get_device: Command to request for device managed by TISCI * Returns 0 for successful exclusive request, else returns * corresponding error message. * @idle_device: Command to idle a device managed by TISCI * Returns 0 for successful exclusive request, else returns * corresponding error message. * @put_device: Command to release a device managed by TISCI * Returns 0 for successful release, else returns corresponding * error message. * @is_valid: Check if the device ID is a valid ID. * Returns 0 if the ID is valid, else returns corresponding error. * @get_context_loss_count: Command to retrieve context loss counter - this * increments every time the device looses context. Overflow * is possible. * - count: pointer to u32 which will retrieve counter * Returns 0 for successful information request and count has * proper data, else returns corresponding error message. * @is_idle: Reports back about device idle state * - req_state: Returns requested idle state * Returns 0 for successful information request and req_state and * current_state has proper data, else returns corresponding error * message. * @is_stop: Reports back about device stop state * - req_state: Returns requested stop state * - current_state: Returns current stop state * Returns 0 for successful information request and req_state and * current_state has proper data, else returns corresponding error * message. * @is_on: Reports back about device ON(or active) state * - req_state: Returns requested ON state * - current_state: Returns current ON state * Returns 0 for successful information request and req_state and * current_state has proper data, else returns corresponding error * message. * @is_transitioning: Reports back if the device is in the middle of transition * of state. * -current_state: Returns 'true' if currently transitioning. * @set_device_resets: Command to configure resets for device managed by TISCI. * -reset_state: Device specific reset bit field * Returns 0 for successful request, else returns * corresponding error message. * @get_device_resets: Command to read state of resets for device managed * by TISCI. * -reset_state: pointer to u32 which will retrieve resets * Returns 0 for successful request, else returns * corresponding error message. * * NOTE: for all these functions, the following parameters are generic in * nature: * -handle: Pointer to TISCI handle as retrieved by *ti_sci_get_handle * -id: Device Identifier * * Request for the device - NOTE: the client MUST maintain integrity of * usage count by balancing get_device with put_device. No refcounting is * managed by driver for that purpose. */ struct ti_sci_dev_ops { … }; /** * struct ti_sci_clk_ops - Clock control operations * @get_clock: Request for activation of clock and manage by processor * - needs_ssc: 'true' if Spread Spectrum clock is desired. * - can_change_freq: 'true' if frequency change is desired. * - enable_input_term: 'true' if input termination is desired. * @idle_clock: Request for Idling a clock managed by processor * @put_clock: Release the clock to be auto managed by TISCI * @is_auto: Is the clock being auto managed * - req_state: state indicating if the clock is auto managed * @is_on: Is the clock ON * - req_state: if the clock is requested to be forced ON * - current_state: if the clock is currently ON * @is_off: Is the clock OFF * - req_state: if the clock is requested to be forced OFF * - current_state: if the clock is currently Gated * @set_parent: Set the clock source of a specific device clock * - parent_id: Parent clock identifier to set. * @get_parent: Get the current clock source of a specific device clock * - parent_id: Parent clock identifier which is the parent. * @get_num_parents: Get the number of parents of the current clock source * - num_parents: returns the number of parent clocks. * @get_best_match_freq: Find a best matching frequency for a frequency * range. * - match_freq: Best matching frequency in Hz. * @set_freq: Set the Clock frequency * @get_freq: Get the Clock frequency * - current_freq: Frequency in Hz that the clock is at. * * NOTE: for all these functions, the following parameters are generic in * nature: * -handle: Pointer to TISCI handle as retrieved by *ti_sci_get_handle * -did: Device identifier this request is for * -cid: Clock identifier for the device for this request. * Each device has it's own set of clock inputs. This indexes * which clock input to modify. * -min_freq: The minimum allowable frequency in Hz. This is the minimum * allowable programmed frequency and does not account for clock * tolerances and jitter. * -target_freq: The target clock frequency in Hz. A frequency will be * processed as close to this target frequency as possible. * -max_freq: The maximum allowable frequency in Hz. This is the maximum * allowable programmed frequency and does not account for clock * tolerances and jitter. * * Request for the clock - NOTE: the client MUST maintain integrity of * usage count by balancing get_clock with put_clock. No refcounting is * managed by driver for that purpose. */ struct ti_sci_clk_ops { … }; /** * struct ti_sci_resource_desc - Description of TI SCI resource instance range. * @start: Start index of the first resource range. * @num: Number of resources in the first range. * @start_sec: Start index of the second resource range. * @num_sec: Number of resources in the second range. * @res_map: Bitmap to manage the allocation of these resources. */ struct ti_sci_resource_desc { … }; /** * struct ti_sci_rm_core_ops - Resource management core operations * @get_range: Get a range of resources belonging to ti sci host. * @get_rage_from_shost: Get a range of resources belonging to * specified host id. * - s_host: Host processing entity to which the * resources are allocated * * NOTE: for these functions, all the parameters are consolidated and defined * as below: * - handle: Pointer to TISCI handle as retrieved by *ti_sci_get_handle * - dev_id: TISCI device ID. * - subtype: Resource assignment subtype that is being requested * from the given device. * - desc: Pointer to ti_sci_resource_desc to be updated with the resource * range start index and number of resources */ struct ti_sci_rm_core_ops { … }; #define TI_SCI_RESASG_SUBTYPE_IR_OUTPUT … #define TI_SCI_RESASG_SUBTYPE_IA_VINT … #define TI_SCI_RESASG_SUBTYPE_GLOBAL_EVENT_SEVT … /** * struct ti_sci_rm_irq_ops: IRQ management operations * @set_irq: Set an IRQ route between the requested source * and destination * @set_event_map: Set an Event based peripheral irq to Interrupt * Aggregator. * @free_irq: Free an IRQ route between the requested source * and destination. * @free_event_map: Free an event based peripheral irq to Interrupt * Aggregator. */ struct ti_sci_rm_irq_ops { … }; /* RA config.addr_lo parameter is valid for RM ring configure TI_SCI message */ #define TI_SCI_MSG_VALUE_RM_RING_ADDR_LO_VALID … /* RA config.addr_hi parameter is valid for RM ring configure TI_SCI message */ #define TI_SCI_MSG_VALUE_RM_RING_ADDR_HI_VALID … /* RA config.count parameter is valid for RM ring configure TI_SCI message */ #define TI_SCI_MSG_VALUE_RM_RING_COUNT_VALID … /* RA config.mode parameter is valid for RM ring configure TI_SCI message */ #define TI_SCI_MSG_VALUE_RM_RING_MODE_VALID … /* RA config.size parameter is valid for RM ring configure TI_SCI message */ #define TI_SCI_MSG_VALUE_RM_RING_SIZE_VALID … /* RA config.order_id parameter is valid for RM ring configure TISCI message */ #define TI_SCI_MSG_VALUE_RM_RING_ORDER_ID_VALID … /* RA config.virtid parameter is valid for RM ring configure TISCI message */ #define TI_SCI_MSG_VALUE_RM_RING_VIRTID_VALID … /* RA config.asel parameter is valid for RM ring configure TISCI message */ #define TI_SCI_MSG_VALUE_RM_RING_ASEL_VALID … #define TI_SCI_MSG_VALUE_RM_ALL_NO_ORDER … /** * struct ti_sci_msg_rm_ring_cfg - Ring configuration * * Parameters for Navigator Subsystem ring configuration * See @ti_sci_msg_rm_ring_cfg_req */ struct ti_sci_msg_rm_ring_cfg { … }; /** * struct ti_sci_rm_ringacc_ops - Ring Accelerator Management operations * @set_cfg: configure the SoC Navigator Subsystem Ring Accelerator ring */ struct ti_sci_rm_ringacc_ops { … }; /** * struct ti_sci_rm_psil_ops - PSI-L thread operations * @pair: pair PSI-L source thread to a destination thread. * If the src_thread is mapped to UDMA tchan, the corresponding channel's * TCHAN_THRD_ID register is updated. * If the dst_thread is mapped to UDMA rchan, the corresponding channel's * RCHAN_THRD_ID register is updated. * @unpair: unpair PSI-L source thread from a destination thread. * If the src_thread is mapped to UDMA tchan, the corresponding channel's * TCHAN_THRD_ID register is cleared. * If the dst_thread is mapped to UDMA rchan, the corresponding channel's * RCHAN_THRD_ID register is cleared. */ struct ti_sci_rm_psil_ops { … }; /* UDMAP channel types */ #define TI_SCI_RM_UDMAP_CHAN_TYPE_PKT_PBRR … #define TI_SCI_RM_UDMAP_CHAN_TYPE_PKT_PBRR_SB … #define TI_SCI_RM_UDMAP_CHAN_TYPE_3RDP_PBRR … #define TI_SCI_RM_UDMAP_CHAN_TYPE_3RDP_PBVR … #define TI_SCI_RM_UDMAP_CHAN_TYPE_3RDP_BCOPY_PBRR … #define TI_SCI_RM_UDMAP_CHAN_TYPE_3RDP_BCOPY_PBVR … #define TI_SCI_RM_UDMAP_RX_FLOW_DESC_HOST … #define TI_SCI_RM_UDMAP_RX_FLOW_DESC_MONO … #define TI_SCI_RM_UDMAP_CHAN_BURST_SIZE_64_BYTES … #define TI_SCI_RM_UDMAP_CHAN_BURST_SIZE_128_BYTES … #define TI_SCI_RM_UDMAP_CHAN_BURST_SIZE_256_BYTES … #define TI_SCI_RM_BCDMA_EXTENDED_CH_TYPE_TCHAN … #define TI_SCI_RM_BCDMA_EXTENDED_CH_TYPE_BCHAN … /* UDMAP TX/RX channel valid_params common declarations */ #define TI_SCI_MSG_VALUE_RM_UDMAP_CH_PAUSE_ON_ERR_VALID … #define TI_SCI_MSG_VALUE_RM_UDMAP_CH_ATYPE_VALID … #define TI_SCI_MSG_VALUE_RM_UDMAP_CH_CHAN_TYPE_VALID … #define TI_SCI_MSG_VALUE_RM_UDMAP_CH_FETCH_SIZE_VALID … #define TI_SCI_MSG_VALUE_RM_UDMAP_CH_CQ_QNUM_VALID … #define TI_SCI_MSG_VALUE_RM_UDMAP_CH_PRIORITY_VALID … #define TI_SCI_MSG_VALUE_RM_UDMAP_CH_QOS_VALID … #define TI_SCI_MSG_VALUE_RM_UDMAP_CH_ORDER_ID_VALID … #define TI_SCI_MSG_VALUE_RM_UDMAP_CH_SCHED_PRIORITY_VALID … #define TI_SCI_MSG_VALUE_RM_UDMAP_CH_BURST_SIZE_VALID … /** * Configures a Navigator Subsystem UDMAP transmit channel * * Configures a Navigator Subsystem UDMAP transmit channel registers. * See @ti_sci_msg_rm_udmap_tx_ch_cfg_req */ struct ti_sci_msg_rm_udmap_tx_ch_cfg { … }; /** * Configures a Navigator Subsystem UDMAP receive channel * * Configures a Navigator Subsystem UDMAP receive channel registers. * See @ti_sci_msg_rm_udmap_rx_ch_cfg_req */ struct ti_sci_msg_rm_udmap_rx_ch_cfg { … }; /** * Configures a Navigator Subsystem UDMAP receive flow * * Configures a Navigator Subsystem UDMAP receive flow's registers. * See @tis_ci_msg_rm_udmap_flow_cfg_req */ struct ti_sci_msg_rm_udmap_flow_cfg { … }; /** * struct ti_sci_rm_udmap_ops - UDMA Management operations * @tx_ch_cfg: configure SoC Navigator Subsystem UDMA transmit channel. * @rx_ch_cfg: configure SoC Navigator Subsystem UDMA receive channel. * @rx_flow_cfg1: configure SoC Navigator Subsystem UDMA receive flow. */ struct ti_sci_rm_udmap_ops { … }; /** * struct ti_sci_proc_ops - Processor Control operations * @request: Request to control a physical processor. The requesting host * should be in the processor access list * @release: Relinquish a physical processor control * @handover: Handover a physical processor control to another host * in the permitted list * @set_config: Set base configuration of a processor * @set_control: Setup limited control flags in specific cases * @get_status: Get the state of physical processor * * NOTE: The following paramteres are generic in nature for all these ops, * -handle: Pointer to TI SCI handle as retrieved by *ti_sci_get_handle * -pid: Processor ID * -hid: Host ID */ struct ti_sci_proc_ops { … }; /** * struct ti_sci_ops - Function support for TI SCI * @dev_ops: Device specific operations * @clk_ops: Clock specific operations * @rm_core_ops: Resource management core operations. * @rm_irq_ops: IRQ management specific operations * @proc_ops: Processor Control specific operations */ struct ti_sci_ops { … }; /** * struct ti_sci_handle - Handle returned to TI SCI clients for usage. * @version: structure containing version information * @ops: operations that are made available to TI SCI clients */ struct ti_sci_handle { … }; #define TI_SCI_RESOURCE_NULL … /** * struct ti_sci_resource - Structure representing a resource assigned * to a device. * @sets: Number of sets available from this resource type * @lock: Lock to guard the res map in each set. * @desc: Array of resource descriptors. */ struct ti_sci_resource { … }; #if IS_ENABLED(CONFIG_TI_SCI_PROTOCOL) const struct ti_sci_handle *ti_sci_get_handle(struct device *dev); int ti_sci_put_handle(const struct ti_sci_handle *handle); const struct ti_sci_handle *devm_ti_sci_get_handle(struct device *dev); const struct ti_sci_handle *ti_sci_get_by_phandle(struct device_node *np, const char *property); const struct ti_sci_handle *devm_ti_sci_get_by_phandle(struct device *dev, const char *property); u16 ti_sci_get_free_resource(struct ti_sci_resource *res); void ti_sci_release_resource(struct ti_sci_resource *res, u16 id); u32 ti_sci_get_num_resources(struct ti_sci_resource *res); struct ti_sci_resource * devm_ti_sci_get_of_resource(const struct ti_sci_handle *handle, struct device *dev, u32 dev_id, char *of_prop); struct ti_sci_resource * devm_ti_sci_get_resource(const struct ti_sci_handle *handle, struct device *dev, u32 dev_id, u32 sub_type); #else /* CONFIG_TI_SCI_PROTOCOL */ static inline const struct ti_sci_handle *ti_sci_get_handle(struct device *dev) { … } static inline int ti_sci_put_handle(const struct ti_sci_handle *handle) { … } static inline const struct ti_sci_handle *devm_ti_sci_get_handle(struct device *dev) { … } static inline const struct ti_sci_handle *ti_sci_get_by_phandle(struct device_node *np, const char *property) { … } static inline const struct ti_sci_handle *devm_ti_sci_get_by_phandle(struct device *dev, const char *property) { … } static inline u16 ti_sci_get_free_resource(struct ti_sci_resource *res) { … } static inline void ti_sci_release_resource(struct ti_sci_resource *res, u16 id) { … } static inline u32 ti_sci_get_num_resources(struct ti_sci_resource *res) { … } static inline struct ti_sci_resource * devm_ti_sci_get_of_resource(const struct ti_sci_handle *handle, struct device *dev, u32 dev_id, char *of_prop) { … } static inline struct ti_sci_resource * devm_ti_sci_get_resource(const struct ti_sci_handle *handle, struct device *dev, u32 dev_id, u32 sub_type) { … } #endif /* CONFIG_TI_SCI_PROTOCOL */ #endif /* __TISCI_PROTOCOL_H */
Codebase Browser
linux