include/linux/soc/ti/ti_sci_protocol.h

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Texas Instruments System Control Interface Protocol
   4  *
   5  * Copyright (C) 2015-2016 Texas Instruments Incorporated - http://www.ti.com/
   6  *      Nishanth Menon
   7  */
   8
   9 #ifndef __TISCI_PROTOCOL_H
  10 #define __TISCI_PROTOCOL_H
  11
  12 /**
  13  * struct ti_sci_version_info - version information structure
  14  * @abi_major:  Major ABI version. Change here implies risk of backward
  15  *              compatibility break.
  16  * @abi_minor:  Minor ABI version. Change here implies new feature addition,
  17  *              or compatible change in ABI.
  18  * @firmware_revision:  Firmware revision (not usually used).
  19  * @firmware_description: Firmware description (not usually used).
  20  */
  21 struct ti_sci_version_info {
  22         u8 abi_major;
  23         u8 abi_minor;
  24         u16 firmware_revision;
  25         char firmware_description[32];
  26 };
  27
  28 struct ti_sci_handle;
  29
  30 /**
  31  * struct ti_sci_core_ops - SoC Core Operations
  32  * @reboot_device: Reboot the SoC
  33  *              Returns 0 for successful request(ideally should never return),
  34  *              else returns corresponding error value.
  35  */
  36 struct ti_sci_core_ops {
  37         int (*reboot_device)(const struct ti_sci_handle *handle);
  38 };
  39
  40 /**
  41  * struct ti_sci_dev_ops - Device control operations
  42  * @get_device: Command to request for device managed by TISCI
  43  *              Returns 0 for successful exclusive request, else returns
  44  *              corresponding error message.
  45  * @idle_device: Command to idle a device managed by TISCI
  46  *              Returns 0 for successful exclusive request, else returns
  47  *              corresponding error message.
  48  * @put_device: Command to release a device managed by TISCI
  49  *              Returns 0 for successful release, else returns corresponding
  50  *              error message.
  51  * @is_valid:   Check if the device ID is a valid ID.
  52  *              Returns 0 if the ID is valid, else returns corresponding error.
  53  * @get_context_loss_count: Command to retrieve context loss counter - this
  54  *              increments every time the device looses context. Overflow
  55  *              is possible.
  56  *              - count: pointer to u32 which will retrieve counter
  57  *              Returns 0 for successful information request and count has
  58  *              proper data, else returns corresponding error message.
  59  * @is_idle:    Reports back about device idle state
  60  *              - req_state: Returns requested idle state
  61  *              Returns 0 for successful information request and req_state and
  62  *              current_state has proper data, else returns corresponding error
  63  *              message.
  64  * @is_stop:    Reports back about device stop state
  65  *              - req_state: Returns requested stop state
  66  *              - current_state: Returns current stop state
  67  *              Returns 0 for successful information request and req_state and
  68  *              current_state has proper data, else returns corresponding error
  69  *              message.
  70  * @is_on:      Reports back about device ON(or active) state
  71  *              - req_state: Returns requested ON state
  72  *              - current_state: Returns current ON state
  73  *              Returns 0 for successful information request and req_state and
  74  *              current_state has proper data, else returns corresponding error
  75  *              message.
  76  * @is_transitioning: Reports back if the device is in the middle of transition
  77  *              of state.
  78  *              -current_state: Returns 'true' if currently transitioning.
  79  * @set_device_resets: Command to configure resets for device managed by TISCI.
  80  *              -reset_state: Device specific reset bit field
  81  *              Returns 0 for successful request, else returns
  82  *              corresponding error message.
  83  * @get_device_resets: Command to read state of resets for device managed
  84  *              by TISCI.
  85  *              -reset_state: pointer to u32 which will retrieve resets
  86  *              Returns 0 for successful request, else returns
  87  *              corresponding error message.
  88  *
  89  * NOTE: for all these functions, the following parameters are generic in
  90  * nature:
  91  * -handle:     Pointer to TISCI handle as retrieved by *ti_sci_get_handle
  92  * -id:         Device Identifier
  93  *
  94  * Request for the device - NOTE: the client MUST maintain integrity of
  95  * usage count by balancing get_device with put_device. No refcounting is
  96  * managed by driver for that purpose.
  97  */
  98 struct ti_sci_dev_ops {
  99         int (*get_device)(const struct ti_sci_handle *handle, u32 id);
 100         int (*idle_device)(const struct ti_sci_handle *handle, u32 id);
 101         int (*put_device)(const struct ti_sci_handle *handle, u32 id);
 102         int (*is_valid)(const struct ti_sci_handle *handle, u32 id);
 103         int (*get_context_loss_count)(const struct ti_sci_handle *handle,
 104                                       u32 id, u32 *count);
 105         int (*is_idle)(const struct ti_sci_handle *handle, u32 id,
 106                        bool *requested_state);
 107         int (*is_stop)(const struct ti_sci_handle *handle, u32 id,
 108                        bool *req_state, bool *current_state);
 109         int (*is_on)(const struct ti_sci_handle *handle, u32 id,
 110                      bool *req_state, bool *current_state);
 111         int (*is_transitioning)(const struct ti_sci_handle *handle, u32 id,
 112                                 bool *current_state);
 113         int (*set_device_resets)(const struct ti_sci_handle *handle, u32 id,
 114                                  u32 reset_state);
 115         int (*get_device_resets)(const struct ti_sci_handle *handle, u32 id,
 116                                  u32 *reset_state);
 117 };
 118
 119 /**
 120  * struct ti_sci_clk_ops - Clock control operations
 121  * @get_clock:  Request for activation of clock and manage by processor
 122  *              - needs_ssc: 'true' if Spread Spectrum clock is desired.
 123  *              - can_change_freq: 'true' if frequency change is desired.
 124  *              - enable_input_term: 'true' if input termination is desired.
 125  * @idle_clock: Request for Idling a clock managed by processor
 126  * @put_clock:  Release the clock to be auto managed by TISCI
 127  * @is_auto:    Is the clock being auto managed
 128  *              - req_state: state indicating if the clock is auto managed
 129  * @is_on:      Is the clock ON
 130  *              - req_state: if the clock is requested to be forced ON
 131  *              - current_state: if the clock is currently ON
 132  * @is_off:     Is the clock OFF
 133  *              - req_state: if the clock is requested to be forced OFF
 134  *              - current_state: if the clock is currently Gated
 135  * @set_parent: Set the clock source of a specific device clock
 136  *              - parent_id: Parent clock identifier to set.
 137  * @get_parent: Get the current clock source of a specific device clock
 138  *              - parent_id: Parent clock identifier which is the parent.
 139  * @get_num_parents: Get the number of parents of the current clock source
 140  *              - num_parents: returns the number of parent clocks.
 141  * @get_best_match_freq: Find a best matching frequency for a frequency
 142  *              range.
 143  *              - match_freq: Best matching frequency in Hz.
 144  * @set_freq:   Set the Clock frequency
 145  * @get_freq:   Get the Clock frequency
 146  *              - current_freq: Frequency in Hz that the clock is at.
 147  *
 148  * NOTE: for all these functions, the following parameters are generic in
 149  * nature:
 150  * -handle:     Pointer to TISCI handle as retrieved by *ti_sci_get_handle
 151  * -did:        Device identifier this request is for
 152  * -cid:        Clock identifier for the device for this request.
 153  *              Each device has it's own set of clock inputs. This indexes
 154  *              which clock input to modify.
 155  * -min_freq:   The minimum allowable frequency in Hz. This is the minimum
 156  *              allowable programmed frequency and does not account for clock
 157  *              tolerances and jitter.
 158  * -target_freq: The target clock frequency in Hz. A frequency will be
 159  *              processed as close to this target frequency as possible.
 160  * -max_freq:   The maximum allowable frequency in Hz. This is the maximum
 161  *              allowable programmed frequency and does not account for clock
 162  *              tolerances and jitter.
 163  *
 164  * Request for the clock - NOTE: the client MUST maintain integrity of
 165  * usage count by balancing get_clock with put_clock. No refcounting is
 166  * managed by driver for that purpose.
 167  */
 168 struct ti_sci_clk_ops {
 169         int (*get_clock)(const struct ti_sci_handle *handle, u32 did, u8 cid,
 170                          bool needs_ssc, bool can_change_freq,
 171                          bool enable_input_term);
 172         int (*idle_clock)(const struct ti_sci_handle *handle, u32 did, u8 cid);
 173         int (*put_clock)(const struct ti_sci_handle *handle, u32 did, u8 cid);
 174         int (*is_auto)(const struct ti_sci_handle *handle, u32 did, u8 cid,
 175                        bool *req_state);
 176         int (*is_on)(const struct ti_sci_handle *handle, u32 did, u8 cid,
 177                      bool *req_state, bool *current_state);
 178         int (*is_off)(const struct ti_sci_handle *handle, u32 did, u8 cid,
 179                       bool *req_state, bool *current_state);
 180         int (*set_parent)(const struct ti_sci_handle *handle, u32 did, u8 cid,
 181                           u8 parent_id);
 182         int (*get_parent)(const struct ti_sci_handle *handle, u32 did, u8 cid,
 183                           u8 *parent_id);
 184         int (*get_num_parents)(const struct ti_sci_handle *handle, u32 did,
 185                                u8 cid, u8 *num_parents);
 186         int (*get_best_match_freq)(const struct ti_sci_handle *handle, u32 did,
 187                                    u8 cid, u64 min_freq, u64 target_freq,
 188                                    u64 max_freq, u64 *match_freq);
 189         int (*set_freq)(const struct ti_sci_handle *handle, u32 did, u8 cid,
 190                         u64 min_freq, u64 target_freq, u64 max_freq);
 191         int (*get_freq)(const struct ti_sci_handle *handle, u32 did, u8 cid,
 192                         u64 *current_freq);
 193 };
 194
 195 /**
 196  * struct ti_sci_rm_core_ops - Resource management core operations
 197  * @get_range:          Get a range of resources belonging to ti sci host.
 198  * @get_rage_from_shost:        Get a range of resources belonging to
 199  *                              specified host id.
 200  *                      - s_host: Host processing entity to which the
 201  *                                resources are allocated
 202  *
 203  * NOTE: for these functions, all the parameters are consolidated and defined
 204  * as below:
 205  * - handle:    Pointer to TISCI handle as retrieved by *ti_sci_get_handle
 206  * - dev_id:    TISCI device ID.
 207  * - subtype:   Resource assignment subtype that is being requested
 208  *              from the given device.
 209  * - range_start:       Start index of the resource range
 210  * - range_end:         Number of resources in the range
 211  */
 212 struct ti_sci_rm_core_ops {
 213         int (*get_range)(const struct ti_sci_handle *handle, u32 dev_id,
 214                          u8 subtype, u16 *range_start, u16 *range_num);
 215         int (*get_range_from_shost)(const struct ti_sci_handle *handle,
 216                                     u32 dev_id, u8 subtype, u8 s_host,
 217                                     u16 *range_start, u16 *range_num);
 218 };
 219
 220 /**
 221  * struct ti_sci_rm_irq_ops: IRQ management operations
 222  * @set_irq:            Set an IRQ route between the requested source
 223  *                      and destination
 224  * @set_event_map:      Set an Event based peripheral irq to Interrupt
 225  *                      Aggregator.
 226  * @free_irq:           Free an an IRQ route between the requested source
 227  *                      destination.
 228  * @free_event_map:     Free an event based peripheral irq to Interrupt
 229  *                      Aggregator.
 230  */
 231 struct ti_sci_rm_irq_ops {
 232         int (*set_irq)(const struct ti_sci_handle *handle, u16 src_id,
 233                        u16 src_index, u16 dst_id, u16 dst_host_irq);
 234         int (*set_event_map)(const struct ti_sci_handle *handle, u16 src_id,
 235                              u16 src_index, u16 ia_id, u16 vint,
 236                              u16 global_event, u8 vint_status_bit);
 237         int (*free_irq)(const struct ti_sci_handle *handle, u16 src_id,
 238                         u16 src_index, u16 dst_id, u16 dst_host_irq);
 239         int (*free_event_map)(const struct ti_sci_handle *handle, u16 src_id,
 240                               u16 src_index, u16 ia_id, u16 vint,
 241                               u16 global_event, u8 vint_status_bit);
 242 };
 243
 244 /**
 245  * struct ti_sci_ops - Function support for TI SCI
 246  * @dev_ops:    Device specific operations
 247  * @clk_ops:    Clock specific operations
 248  * @rm_core_ops:        Resource management core operations.
 249  * @rm_irq_ops:         IRQ management specific operations
 250  */
 251 struct ti_sci_ops {
 252         struct ti_sci_core_ops core_ops;
 253         struct ti_sci_dev_ops dev_ops;
 254         struct ti_sci_clk_ops clk_ops;
 255         struct ti_sci_rm_core_ops rm_core_ops;
 256         struct ti_sci_rm_irq_ops rm_irq_ops;
 257 };
 258
 259 /**
 260  * struct ti_sci_handle - Handle returned to TI SCI clients for usage.
 261  * @version:    structure containing version information
 262  * @ops:        operations that are made available to TI SCI clients
 263  */
 264 struct ti_sci_handle {
 265         struct ti_sci_version_info version;
 266         struct ti_sci_ops ops;
 267 };
 268
 269 #define TI_SCI_RESOURCE_NULL    0xffff
 270
 271 /**
 272  * struct ti_sci_resource_desc - Description of TI SCI resource instance range.
 273  * @start:      Start index of the resource.
 274  * @num:        Number of resources.
 275  * @res_map:    Bitmap to manage the allocation of these resources.
 276  */
 277 struct ti_sci_resource_desc {
 278         u16 start;
 279         u16 num;
 280         unsigned long *res_map;
 281 };
 282
 283 /**
 284  * struct ti_sci_resource - Structure representing a resource assigned
 285  *                          to a device.
 286  * @sets:       Number of sets available from this resource type
 287  * @lock:       Lock to guard the res map in each set.
 288  * @desc:       Array of resource descriptors.
 289  */
 290 struct ti_sci_resource {
 291         u16 sets;
 292         raw_spinlock_t lock;
 293         struct ti_sci_resource_desc *desc;
 294 };
 295
 296 #if IS_ENABLED(CONFIG_TI_SCI_PROTOCOL)
 297 const struct ti_sci_handle *ti_sci_get_handle(struct device *dev);
 298 int ti_sci_put_handle(const struct ti_sci_handle *handle);
 299 const struct ti_sci_handle *devm_ti_sci_get_handle(struct device *dev);
 300 const struct ti_sci_handle *ti_sci_get_by_phandle(struct device_node *np,
 301                                                   const char *property);
 302 const struct ti_sci_handle *devm_ti_sci_get_by_phandle(struct device *dev,
 303                                                        const char *property);
 304 u16 ti_sci_get_free_resource(struct ti_sci_resource *res);
 305 void ti_sci_release_resource(struct ti_sci_resource *res, u16 id);
 306 u32 ti_sci_get_num_resources(struct ti_sci_resource *res);
 307 struct ti_sci_resource *
 308 devm_ti_sci_get_of_resource(const struct ti_sci_handle *handle,
 309                             struct device *dev, u32 dev_id, char *of_prop);
 310
 311 #else   /* CONFIG_TI_SCI_PROTOCOL */
 312
 313 static inline const struct ti_sci_handle *ti_sci_get_handle(struct device *dev)
 314 {
 315         return ERR_PTR(-EINVAL);
 316 }
 317
 318 static inline int ti_sci_put_handle(const struct ti_sci_handle *handle)
 319 {
 320         return -EINVAL;
 321 }
 322
 323 static inline
 324 const struct ti_sci_handle *devm_ti_sci_get_handle(struct device *dev)
 325 {
 326         return ERR_PTR(-EINVAL);
 327 }
 328
 329 static inline
 330 const struct ti_sci_handle *ti_sci_get_by_phandle(struct device_node *np,
 331                                                   const char *property)
 332 {
 333         return ERR_PTR(-EINVAL);
 334 }
 335
 336 static inline
 337 const struct ti_sci_handle *devm_ti_sci_get_by_phandle(struct device *dev,
 338                                                        const char *property)
 339 {
 340         return ERR_PTR(-EINVAL);
 341 }
 342
 343 static inline u16 ti_sci_get_free_resource(struct ti_sci_resource *res)
 344 {
 345         return TI_SCI_RESOURCE_NULL;
 346 }
 347
 348 static inline void ti_sci_release_resource(struct ti_sci_resource *res, u16 id)
 349 {
 350 }
 351
 352 static inline u32 ti_sci_get_num_resources(struct ti_sci_resource *res)
 353 {
 354         return 0;
 355 }
 356
 357 static inline struct ti_sci_resource *
 358 devm_ti_sci_get_of_resource(const struct ti_sci_handle *handle,
 359                             struct device *dev, u32 dev_id, char *of_prop)
 360 {
 361         return ERR_PTR(-EINVAL);
 362 }
 363 #endif  /* CONFIG_TI_SCI_PROTOCOL */
 364
 365 #endif  /* __TISCI_PROTOCOL_H */