drivers/firmware/ti_sci.h

   1 /* SPDX-License-Identifier: BSD-3-Clause */
   2 /*
   3  * Texas Instruments System Control Interface (TISCI) Protocol
   4  *
   5  * Communication protocol with TI SCI hardware
   6  * The system works in a message response protocol
   7  * See: http://processors.wiki.ti.com/index.php/TISCI for details
   8  *
   9  * Copyright (C)  2015-2016 Texas Instruments Incorporated - https://www.ti.com/
  10  */
  11
  12 #ifndef __TI_SCI_H
  13 #define __TI_SCI_H
  14
  15 /* Generic Messages */
  16 #define TI_SCI_MSG_ENABLE_WDT   0x0000
  17 #define TI_SCI_MSG_WAKE_RESET   0x0001
  18 #define TI_SCI_MSG_VERSION      0x0002
  19 #define TI_SCI_MSG_WAKE_REASON  0x0003
  20 #define TI_SCI_MSG_GOODBYE      0x0004
  21 #define TI_SCI_MSG_SYS_RESET    0x0005
  22
  23 /* Device requests */
  24 #define TI_SCI_MSG_SET_DEVICE_STATE     0x0200
  25 #define TI_SCI_MSG_GET_DEVICE_STATE     0x0201
  26 #define TI_SCI_MSG_SET_DEVICE_RESETS    0x0202
  27
  28 /* Clock requests */
  29 #define TI_SCI_MSG_SET_CLOCK_STATE      0x0100
  30 #define TI_SCI_MSG_GET_CLOCK_STATE      0x0101
  31 #define TI_SCI_MSG_SET_CLOCK_PARENT     0x0102
  32 #define TI_SCI_MSG_GET_CLOCK_PARENT     0x0103
  33 #define TI_SCI_MSG_GET_NUM_CLOCK_PARENTS 0x0104
  34 #define TI_SCI_MSG_SET_CLOCK_FREQ       0x010c
  35 #define TI_SCI_MSG_QUERY_CLOCK_FREQ     0x010d
  36 #define TI_SCI_MSG_GET_CLOCK_FREQ       0x010e
  37
  38 /* Resource Management Requests */
  39 #define TI_SCI_MSG_GET_RESOURCE_RANGE   0x1500
  40
  41 /* IRQ requests */
  42 #define TI_SCI_MSG_SET_IRQ              0x1000
  43 #define TI_SCI_MSG_FREE_IRQ             0x1001
  44
  45 /* NAVSS resource management */
  46 /* Ringacc requests */
  47 #define TI_SCI_MSG_RM_RING_ALLOCATE             0x1100
  48 #define TI_SCI_MSG_RM_RING_FREE                 0x1101
  49 #define TI_SCI_MSG_RM_RING_RECONFIG             0x1102
  50 #define TI_SCI_MSG_RM_RING_RESET                0x1103
  51 #define TI_SCI_MSG_RM_RING_CFG                  0x1110
  52 #define TI_SCI_MSG_RM_RING_GET_CFG              0x1111
  53
  54 /* PSI-L requests */
  55 #define TI_SCI_MSG_RM_PSIL_PAIR                 0x1280
  56 #define TI_SCI_MSG_RM_PSIL_UNPAIR               0x1281
  57
  58 #define TI_SCI_MSG_RM_UDMAP_TX_ALLOC            0x1200
  59 #define TI_SCI_MSG_RM_UDMAP_TX_FREE             0x1201
  60 #define TI_SCI_MSG_RM_UDMAP_RX_ALLOC            0x1210
  61 #define TI_SCI_MSG_RM_UDMAP_RX_FREE             0x1211
  62 #define TI_SCI_MSG_RM_UDMAP_FLOW_CFG            0x1220
  63 #define TI_SCI_MSG_RM_UDMAP_OPT_FLOW_CFG        0x1221
  64
  65 #define TISCI_MSG_RM_UDMAP_TX_CH_CFG            0x1205
  66 #define TISCI_MSG_RM_UDMAP_TX_CH_GET_CFG        0x1206
  67 #define TISCI_MSG_RM_UDMAP_RX_CH_CFG            0x1215
  68 #define TISCI_MSG_RM_UDMAP_RX_CH_GET_CFG        0x1216
  69 #define TISCI_MSG_RM_UDMAP_FLOW_CFG             0x1230
  70 #define TISCI_MSG_RM_UDMAP_FLOW_SIZE_THRESH_CFG 0x1231
  71 #define TISCI_MSG_RM_UDMAP_FLOW_GET_CFG         0x1232
  72 #define TISCI_MSG_RM_UDMAP_FLOW_SIZE_THRESH_GET_CFG     0x1233
  73
  74 /* Processor Control requests */
  75 #define TI_SCI_MSG_PROC_REQUEST         0xc000
  76 #define TI_SCI_MSG_PROC_RELEASE         0xc001
  77 #define TI_SCI_MSG_PROC_HANDOVER        0xc005
  78 #define TI_SCI_MSG_SET_CONFIG           0xc100
  79 #define TI_SCI_MSG_SET_CTRL             0xc101
  80 #define TI_SCI_MSG_GET_STATUS           0xc400
  81
  82 /**
  83  * struct ti_sci_msg_hdr - Generic Message Header for All messages and responses
  84  * @type:       Type of messages: One of TI_SCI_MSG* values
  85  * @host:       Host of the message
  86  * @seq:        Message identifier indicating a transfer sequence
  87  * @flags:      Flag for the message
  88  */
  89 struct ti_sci_msg_hdr {
  90         u16 type;
  91         u8 host;
  92         u8 seq;
  93 #define TI_SCI_MSG_FLAG(val)                    (1 << (val))
  94 #define TI_SCI_FLAG_REQ_GENERIC_NORESPONSE      0x0
  95 #define TI_SCI_FLAG_REQ_ACK_ON_RECEIVED         TI_SCI_MSG_FLAG(0)
  96 #define TI_SCI_FLAG_REQ_ACK_ON_PROCESSED        TI_SCI_MSG_FLAG(1)
  97 #define TI_SCI_FLAG_RESP_GENERIC_NACK           0x0
  98 #define TI_SCI_FLAG_RESP_GENERIC_ACK            TI_SCI_MSG_FLAG(1)
  99         /* Additional Flags */
 100         u32 flags;
 101 } __packed;
 102
 103 /**
 104  * struct ti_sci_msg_resp_version - Response for a message
 105  * @hdr:                Generic header
 106  * @firmware_description: String describing the firmware
 107  * @firmware_revision:  Firmware revision
 108  * @abi_major:          Major version of the ABI that firmware supports
 109  * @abi_minor:          Minor version of the ABI that firmware supports
 110  *
 111  * In general, ABI version changes follow the rule that minor version increments
 112  * are backward compatible. Major revision changes in ABI may not be
 113  * backward compatible.
 114  *
 115  * Response to a generic message with message type TI_SCI_MSG_VERSION
 116  */
 117 struct ti_sci_msg_resp_version {
 118         struct ti_sci_msg_hdr hdr;
 119         char firmware_description[32];
 120         u16 firmware_revision;
 121         u8 abi_major;
 122         u8 abi_minor;
 123 } __packed;
 124
 125 /**
 126  * struct ti_sci_msg_req_reboot - Reboot the SoC
 127  * @hdr:        Generic Header
 128  *
 129  * Request type is TI_SCI_MSG_SYS_RESET, responded with a generic
 130  * ACK/NACK message.
 131  */
 132 struct ti_sci_msg_req_reboot {
 133         struct ti_sci_msg_hdr hdr;
 134 } __packed;
 135
 136 /**
 137  * struct ti_sci_msg_req_set_device_state - Set the desired state of the device
 138  * @hdr:                Generic header
 139  * @id: Indicates which device to modify
 140  * @reserved: Reserved space in message, must be 0 for backward compatibility
 141  * @state: The desired state of the device.
 142  *
 143  * Certain flags can also be set to alter the device state:
 144  * + MSG_FLAG_DEVICE_WAKE_ENABLED - Configure the device to be a wake source.
 145  * The meaning of this flag will vary slightly from device to device and from
 146  * SoC to SoC but it generally allows the device to wake the SoC out of deep
 147  * suspend states.
 148  * + MSG_FLAG_DEVICE_RESET_ISO - Enable reset isolation for this device.
 149  * + MSG_FLAG_DEVICE_EXCLUSIVE - Claim this device exclusively. When passed
 150  * with STATE_RETENTION or STATE_ON, it will claim the device exclusively.
 151  * If another host already has this device set to STATE_RETENTION or STATE_ON,
 152  * the message will fail. Once successful, other hosts attempting to set
 153  * STATE_RETENTION or STATE_ON will fail.
 154  *
 155  * Request type is TI_SCI_MSG_SET_DEVICE_STATE, responded with a generic
 156  * ACK/NACK message.
 157  */
 158 struct ti_sci_msg_req_set_device_state {
 159         /* Additional hdr->flags options */
 160 #define MSG_FLAG_DEVICE_WAKE_ENABLED    TI_SCI_MSG_FLAG(8)
 161 #define MSG_FLAG_DEVICE_RESET_ISO       TI_SCI_MSG_FLAG(9)
 162 #define MSG_FLAG_DEVICE_EXCLUSIVE       TI_SCI_MSG_FLAG(10)
 163         struct ti_sci_msg_hdr hdr;
 164         u32 id;
 165         u32 reserved;
 166
 167 #define MSG_DEVICE_SW_STATE_AUTO_OFF    0
 168 #define MSG_DEVICE_SW_STATE_RETENTION   1
 169 #define MSG_DEVICE_SW_STATE_ON          2
 170         u8 state;
 171 } __packed;
 172
 173 /**
 174  * struct ti_sci_msg_req_get_device_state - Request to get device.
 175  * @hdr:                Generic header
 176  * @id:         Device Identifier
 177  *
 178  * Request type is TI_SCI_MSG_GET_DEVICE_STATE, responded device state
 179  * information
 180  */
 181 struct ti_sci_msg_req_get_device_state {
 182         struct ti_sci_msg_hdr hdr;
 183         u32 id;
 184 } __packed;
 185
 186 /**
 187  * struct ti_sci_msg_resp_get_device_state - Response to get device request.
 188  * @hdr:                Generic header
 189  * @context_loss_count: Indicates how many times the device has lost context. A
 190  *      driver can use this monotonic counter to determine if the device has
 191  *      lost context since the last time this message was exchanged.
 192  * @resets: Programmed state of the reset lines.
 193  * @programmed_state:   The state as programmed by set_device.
 194  *                      - Uses the MSG_DEVICE_SW_* macros
 195  * @current_state:      The actual state of the hardware.
 196  *
 197  * Response to request TI_SCI_MSG_GET_DEVICE_STATE.
 198  */
 199 struct ti_sci_msg_resp_get_device_state {
 200         struct ti_sci_msg_hdr hdr;
 201         u32 context_loss_count;
 202         u32 resets;
 203         u8 programmed_state;
 204 #define MSG_DEVICE_HW_STATE_OFF         0
 205 #define MSG_DEVICE_HW_STATE_ON          1
 206 #define MSG_DEVICE_HW_STATE_TRANS       2
 207         u8 current_state;
 208 } __packed;
 209
 210 /**
 211  * struct ti_sci_msg_req_set_device_resets - Set the desired resets
 212  *                              configuration of the device
 213  * @hdr:                Generic header
 214  * @id: Indicates which device to modify
 215  * @resets: A bit field of resets for the device. The meaning, behavior,
 216  *      and usage of the reset flags are device specific. 0 for a bit
 217  *      indicates releasing the reset represented by that bit while 1
 218  *      indicates keeping it held.
 219  *
 220  * Request type is TI_SCI_MSG_SET_DEVICE_RESETS, responded with a generic
 221  * ACK/NACK message.
 222  */
 223 struct ti_sci_msg_req_set_device_resets {
 224         struct ti_sci_msg_hdr hdr;
 225         u32 id;
 226         u32 resets;
 227 } __packed;
 228
 229 /**
 230  * struct ti_sci_msg_req_set_clock_state - Request to setup a Clock state
 231  * @hdr:        Generic Header, Certain flags can be set specific to the clocks:
 232  *              MSG_FLAG_CLOCK_ALLOW_SSC: Allow this clock to be modified
 233  *              via spread spectrum clocking.
 234  *              MSG_FLAG_CLOCK_ALLOW_FREQ_CHANGE: Allow this clock's
 235  *              frequency to be changed while it is running so long as it
 236  *              is within the min/max limits.
 237  *              MSG_FLAG_CLOCK_INPUT_TERM: Enable input termination, this
 238  *              is only applicable to clock inputs on the SoC pseudo-device.
 239  * @dev_id:     Device identifier this request is for
 240  * @clk_id:     Clock identifier for the device for this request.
 241  *              Each device has it's own set of clock inputs. This indexes
 242  *              which clock input to modify. Set to 255 if clock ID is
 243  *              greater than or equal to 255.
 244  * @request_state: Request the state for the clock to be set to.
 245  *              MSG_CLOCK_SW_STATE_UNREQ: The IP does not require this clock,
 246  *              it can be disabled, regardless of the state of the device
 247  *              MSG_CLOCK_SW_STATE_AUTO: Allow the System Controller to
 248  *              automatically manage the state of this clock. If the device
 249  *              is enabled, then the clock is enabled. If the device is set
 250  *              to off or retention, then the clock is internally set as not
 251  *              being required by the device.(default)
 252  *              MSG_CLOCK_SW_STATE_REQ:  Configure the clock to be enabled,
 253  *              regardless of the state of the device.
 254  * @clk_id_32:  Clock identifier for the device for this request.
 255  *              Only to be used if the clock ID is greater than or equal to
 256  *              255.
 257  *
 258  * Normally, all required clocks are managed by TISCI entity, this is used
 259  * only for specific control *IF* required. Auto managed state is
 260  * MSG_CLOCK_SW_STATE_AUTO, in other states, TISCI entity assume remote
 261  * will explicitly control.
 262  *
 263  * Request type is TI_SCI_MSG_SET_CLOCK_STATE, response is a generic
 264  * ACK or NACK message.
 265  */
 266 struct ti_sci_msg_req_set_clock_state {
 267         /* Additional hdr->flags options */
 268 #define MSG_FLAG_CLOCK_ALLOW_SSC                TI_SCI_MSG_FLAG(8)
 269 #define MSG_FLAG_CLOCK_ALLOW_FREQ_CHANGE        TI_SCI_MSG_FLAG(9)
 270 #define MSG_FLAG_CLOCK_INPUT_TERM               TI_SCI_MSG_FLAG(10)
 271         struct ti_sci_msg_hdr hdr;
 272         u32 dev_id;
 273         u8 clk_id;
 274 #define MSG_CLOCK_SW_STATE_UNREQ        0
 275 #define MSG_CLOCK_SW_STATE_AUTO         1
 276 #define MSG_CLOCK_SW_STATE_REQ          2
 277         u8 request_state;
 278         u32 clk_id_32;
 279 } __packed;
 280
 281 /**
 282  * struct ti_sci_msg_req_get_clock_state - Request for clock state
 283  * @hdr:        Generic Header
 284  * @dev_id:     Device identifier this request is for
 285  * @clk_id:     Clock identifier for the device for this request.
 286  *              Each device has it's own set of clock inputs. This indexes
 287  *              which clock input to get state of. Set to 255 if the clock
 288  *              ID is greater than or equal to 255.
 289  * @clk_id_32:  Clock identifier for the device for the request.
 290  *              Only to be used if the clock ID is greater than or equal to
 291  *              255.
 292  *
 293  * Request type is TI_SCI_MSG_GET_CLOCK_STATE, response is state
 294  * of the clock
 295  */
 296 struct ti_sci_msg_req_get_clock_state {
 297         struct ti_sci_msg_hdr hdr;
 298         u32 dev_id;
 299         u8 clk_id;
 300         u32 clk_id_32;
 301 } __packed;
 302
 303 /**
 304  * struct ti_sci_msg_resp_get_clock_state - Response to get clock state
 305  * @hdr:        Generic Header
 306  * @programmed_state: Any programmed state of the clock. This is one of
 307  *              MSG_CLOCK_SW_STATE* values.
 308  * @current_state: Current state of the clock. This is one of:
 309  *              MSG_CLOCK_HW_STATE_NOT_READY: Clock is not ready
 310  *              MSG_CLOCK_HW_STATE_READY: Clock is ready
 311  *
 312  * Response to TI_SCI_MSG_GET_CLOCK_STATE.
 313  */
 314 struct ti_sci_msg_resp_get_clock_state {
 315         struct ti_sci_msg_hdr hdr;
 316         u8 programmed_state;
 317 #define MSG_CLOCK_HW_STATE_NOT_READY    0
 318 #define MSG_CLOCK_HW_STATE_READY        1
 319         u8 current_state;
 320 } __packed;
 321
 322 /**
 323  * struct ti_sci_msg_req_set_clock_parent - Set the clock parent
 324  * @hdr:        Generic Header
 325  * @dev_id:     Device identifier this request is for
 326  * @clk_id:     Clock identifier for the device for this request.
 327  *              Each device has it's own set of clock inputs. This indexes
 328  *              which clock input to modify. Set to 255 if clock ID is
 329  *              greater than or equal to 255.
 330  * @parent_id:  The new clock parent is selectable by an index via this
 331  *              parameter. Set to 255 if clock ID is greater than or
 332  *              equal to 255.
 333  * @clk_id_32:  Clock identifier if @clk_id field is 255.
 334  * @parent_id_32:       Parent identifier if @parent_id is 255.
 335  *
 336  * Request type is TI_SCI_MSG_SET_CLOCK_PARENT, response is generic
 337  * ACK / NACK message.
 338  */
 339 struct ti_sci_msg_req_set_clock_parent {
 340         struct ti_sci_msg_hdr hdr;
 341         u32 dev_id;
 342         u8 clk_id;
 343         u8 parent_id;
 344         u32 clk_id_32;
 345         u32 parent_id_32;
 346 } __packed;
 347
 348 /**
 349  * struct ti_sci_msg_req_get_clock_parent - Get the clock parent
 350  * @hdr:        Generic Header
 351  * @dev_id:     Device identifier this request is for
 352  * @clk_id:     Clock identifier for the device for this request.
 353  *              Each device has it's own set of clock inputs. This indexes
 354  *              which clock input to get the parent for. If this field
 355  *              contains 255, the actual clock identifier is stored in
 356  *              @clk_id_32.
 357  * @clk_id_32:  Clock identifier if the @clk_id field contains 255.
 358  *
 359  * Request type is TI_SCI_MSG_GET_CLOCK_PARENT, response is parent information
 360  */
 361 struct ti_sci_msg_req_get_clock_parent {
 362         struct ti_sci_msg_hdr hdr;
 363         u32 dev_id;
 364         u8 clk_id;
 365         u32 clk_id_32;
 366 } __packed;
 367
 368 /**
 369  * struct ti_sci_msg_resp_get_clock_parent - Response with clock parent
 370  * @hdr:        Generic Header
 371  * @parent_id:  The current clock parent. If set to 255, the current parent
 372  *              ID can be found from the @parent_id_32 field.
 373  * @parent_id_32:       Current clock parent if @parent_id field is set to
 374  *                      255.
 375  *
 376  * Response to TI_SCI_MSG_GET_CLOCK_PARENT.
 377  */
 378 struct ti_sci_msg_resp_get_clock_parent {
 379         struct ti_sci_msg_hdr hdr;
 380         u8 parent_id;
 381         u32 parent_id_32;
 382 } __packed;
 383
 384 /**
 385  * struct ti_sci_msg_req_get_clock_num_parents - Request to get clock parents
 386  * @hdr:        Generic header
 387  * @dev_id:     Device identifier this request is for
 388  * @clk_id:     Clock identifier for the device for this request. Set to
 389  *              255 if clock ID is greater than or equal to 255.
 390  * @clk_id_32:  Clock identifier if the @clk_id field contains 255.
 391  *
 392  * This request provides information about how many clock parent options
 393  * are available for a given clock to a device. This is typically used
 394  * for input clocks.
 395  *
 396  * Request type is TI_SCI_MSG_GET_NUM_CLOCK_PARENTS, response is appropriate
 397  * message, or NACK in case of inability to satisfy request.
 398  */
 399 struct ti_sci_msg_req_get_clock_num_parents {
 400         struct ti_sci_msg_hdr hdr;
 401         u32 dev_id;
 402         u8 clk_id;
 403         u32 clk_id_32;
 404 } __packed;
 405
 406 /**
 407  * struct ti_sci_msg_resp_get_clock_num_parents - Response for get clk parents
 408  * @hdr:                Generic header
 409  * @num_parents:        Number of clock parents. If set to 255, the actual
 410  *                      number of parents is stored into @num_parents_32
 411  *                      field instead.
 412  * @num_parents_32:     Number of clock parents if @num_parents field is
 413  *                      set to 255.
 414  *
 415  * Response to TI_SCI_MSG_GET_NUM_CLOCK_PARENTS
 416  */
 417 struct ti_sci_msg_resp_get_clock_num_parents {
 418         struct ti_sci_msg_hdr hdr;
 419         u8 num_parents;
 420         u32 num_parents_32;
 421 } __packed;
 422
 423 /**
 424  * struct ti_sci_msg_req_query_clock_freq - Request to query a frequency
 425  * @hdr:        Generic Header
 426  * @dev_id:     Device identifier this request is for
 427  * @min_freq_hz: The minimum allowable frequency in Hz. This is the minimum
 428  *              allowable programmed frequency and does not account for clock
 429  *              tolerances and jitter.
 430  * @target_freq_hz: The target clock frequency. A frequency will be found
 431  *              as close to this target frequency as possible.
 432  * @max_freq_hz: The maximum allowable frequency in Hz. This is the maximum
 433  *              allowable programmed frequency and does not account for clock
 434  *              tolerances and jitter.
 435  * @clk_id:     Clock identifier for the device for this request. Set to
 436  *              255 if clock identifier is greater than or equal to 255.
 437  * @clk_id_32:  Clock identifier if @clk_id is set to 255.
 438  *
 439  * NOTE: Normally clock frequency management is automatically done by TISCI
 440  * entity. In case of specific requests, TISCI evaluates capability to achieve
 441  * requested frequency within provided range and responds with
 442  * result message.
 443  *
 444  * Request type is TI_SCI_MSG_QUERY_CLOCK_FREQ, response is appropriate message,
 445  * or NACK in case of inability to satisfy request.
 446  */
 447 struct ti_sci_msg_req_query_clock_freq {
 448         struct ti_sci_msg_hdr hdr;
 449         u32 dev_id;
 450         u64 min_freq_hz;
 451         u64 target_freq_hz;
 452         u64 max_freq_hz;
 453         u8 clk_id;
 454         u32 clk_id_32;
 455 } __packed;
 456
 457 /**
 458  * struct ti_sci_msg_resp_query_clock_freq - Response to a clock frequency query
 459  * @hdr:        Generic Header
 460  * @freq_hz:    Frequency that is the best match in Hz.
 461  *
 462  * Response to request type TI_SCI_MSG_QUERY_CLOCK_FREQ. NOTE: if the request
 463  * cannot be satisfied, the message will be of type NACK.
 464  */
 465 struct ti_sci_msg_resp_query_clock_freq {
 466         struct ti_sci_msg_hdr hdr;
 467         u64 freq_hz;
 468 } __packed;
 469
 470 /**
 471  * struct ti_sci_msg_req_set_clock_freq - Request to setup a clock frequency
 472  * @hdr:        Generic Header
 473  * @dev_id:     Device identifier this request is for
 474  * @min_freq_hz: The minimum allowable frequency in Hz. This is the minimum
 475  *              allowable programmed frequency and does not account for clock
 476  *              tolerances and jitter.
 477  * @target_freq_hz: The target clock frequency. The clock will be programmed
 478  *              at a rate as close to this target frequency as possible.
 479  * @max_freq_hz: The maximum allowable frequency in Hz. This is the maximum
 480  *              allowable programmed frequency and does not account for clock
 481  *              tolerances and jitter.
 482  * @clk_id:     Clock identifier for the device for this request. Set to
 483  *              255 if clock ID is greater than or equal to 255.
 484  * @clk_id_32:  Clock identifier if @clk_id field is set to 255.
 485  *
 486  * NOTE: Normally clock frequency management is automatically done by TISCI
 487  * entity. In case of specific requests, TISCI evaluates capability to achieve
 488  * requested range and responds with success/failure message.
 489  *
 490  * This sets the desired frequency for a clock within an allowable
 491  * range. This message will fail on an enabled clock unless
 492  * MSG_FLAG_CLOCK_ALLOW_FREQ_CHANGE is set for the clock. Additionally,
 493  * if other clocks have their frequency modified due to this message,
 494  * they also must have the MSG_FLAG_CLOCK_ALLOW_FREQ_CHANGE or be disabled.
 495  *
 496  * Calling set frequency on a clock input to the SoC pseudo-device will
 497  * inform the PMMC of that clock's frequency. Setting a frequency of
 498  * zero will indicate the clock is disabled.
 499  *
 500  * Calling set frequency on clock outputs from the SoC pseudo-device will
 501  * function similarly to setting the clock frequency on a device.
 502  *
 503  * Request type is TI_SCI_MSG_SET_CLOCK_FREQ, response is a generic ACK/NACK
 504  * message.
 505  */
 506 struct ti_sci_msg_req_set_clock_freq {
 507         struct ti_sci_msg_hdr hdr;
 508         u32 dev_id;
 509         u64 min_freq_hz;
 510         u64 target_freq_hz;
 511         u64 max_freq_hz;
 512         u8 clk_id;
 513         u32 clk_id_32;
 514 } __packed;
 515
 516 /**
 517  * struct ti_sci_msg_req_get_clock_freq - Request to get the clock frequency
 518  * @hdr:        Generic Header
 519  * @dev_id:     Device identifier this request is for
 520  * @clk_id:     Clock identifier for the device for this request. Set to
 521  *              255 if clock ID is greater than or equal to 255.
 522  * @clk_id_32:  Clock identifier if @clk_id field is set to 255.
 523  *
 524  * NOTE: Normally clock frequency management is automatically done by TISCI
 525  * entity. In some cases, clock frequencies are configured by host.
 526  *
 527  * Request type is TI_SCI_MSG_GET_CLOCK_FREQ, responded with clock frequency
 528  * that the clock is currently at.
 529  */
 530 struct ti_sci_msg_req_get_clock_freq {
 531         struct ti_sci_msg_hdr hdr;
 532         u32 dev_id;
 533         u8 clk_id;
 534         u32 clk_id_32;
 535 } __packed;
 536
 537 /**
 538  * struct ti_sci_msg_resp_get_clock_freq - Response of clock frequency request
 539  * @hdr:        Generic Header
 540  * @freq_hz:    Frequency that the clock is currently on, in Hz.
 541  *
 542  * Response to request type TI_SCI_MSG_GET_CLOCK_FREQ.
 543  */
 544 struct ti_sci_msg_resp_get_clock_freq {
 545         struct ti_sci_msg_hdr hdr;
 546         u64 freq_hz;
 547 } __packed;
 548
 549 #define TI_SCI_IRQ_SECONDARY_HOST_INVALID       0xff
 550
 551 /**
 552  * struct ti_sci_msg_req_get_resource_range - Request to get a host's assigned
 553  *                                            range of resources.
 554  * @hdr:                Generic Header
 555  * @type:               Unique resource assignment type
 556  * @subtype:            Resource assignment subtype within the resource type.
 557  * @secondary_host:     Host processing entity to which the resources are
 558  *                      allocated. This is required only when the destination
 559  *                      host id id different from ti sci interface host id,
 560  *                      else TI_SCI_IRQ_SECONDARY_HOST_INVALID can be passed.
 561  *
 562  * Request type is TI_SCI_MSG_GET_RESOURCE_RANGE. Responded with requested
 563  * resource range which is of type TI_SCI_MSG_GET_RESOURCE_RANGE.
 564  */
 565 struct ti_sci_msg_req_get_resource_range {
 566         struct ti_sci_msg_hdr hdr;
 567 #define MSG_RM_RESOURCE_TYPE_MASK       GENMASK(9, 0)
 568 #define MSG_RM_RESOURCE_SUBTYPE_MASK    GENMASK(5, 0)
 569         u16 type;
 570         u8 subtype;
 571         u8 secondary_host;
 572 } __packed;
 573
 574 /**
 575  * struct ti_sci_msg_resp_get_resource_range - Response to resource get range.
 576  * @hdr:                Generic Header
 577  * @range_start:        Start index of the first resource range.
 578  * @range_num:          Number of resources in the first range.
 579  * @range_start_sec:    Start index of the second resource range.
 580  * @range_num_sec:      Number of resources in the second range.
 581  *
 582  * Response to request TI_SCI_MSG_GET_RESOURCE_RANGE.
 583  */
 584 struct ti_sci_msg_resp_get_resource_range {
 585         struct ti_sci_msg_hdr hdr;
 586         u16 range_start;
 587         u16 range_num;
 588         u16 range_start_sec;
 589         u16 range_num_sec;
 590 } __packed;
 591
 592 /**
 593  * struct ti_sci_msg_req_manage_irq - Request to configure/release the route
 594  *                                      between the dev and the host.
 595  * @hdr:                Generic Header
 596  * @valid_params:       Bit fields defining the validity of interrupt source
 597  *                      parameters. If a bit is not set, then corresponding
 598  *                      field is not valid and will not be used for route set.
 599  *                      Bit field definitions:
 600  *                      0 - Valid bit for @dst_id
 601  *                      1 - Valid bit for @dst_host_irq
 602  *                      2 - Valid bit for @ia_id
 603  *                      3 - Valid bit for @vint
 604  *                      4 - Valid bit for @global_event
 605  *                      5 - Valid bit for @vint_status_bit_index
 606  *                      31 - Valid bit for @secondary_host
 607  * @src_id:             IRQ source peripheral ID.
 608  * @src_index:          IRQ source index within the peripheral
 609  * @dst_id:             IRQ Destination ID. Based on the architecture it can be
 610  *                      IRQ controller or host processor ID.
 611  * @dst_host_irq:       IRQ number of the destination host IRQ controller
 612  * @ia_id:              Device ID of the interrupt aggregator in which the
 613  *                      vint resides.
 614  * @vint:               Virtual interrupt number if the interrupt route
 615  *                      is through an interrupt aggregator.
 616  * @global_event:       Global event that is to be mapped to interrupt
 617  *                      aggregator virtual interrupt status bit.
 618  * @vint_status_bit:    Virtual interrupt status bit if the interrupt route
 619  *                      utilizes an interrupt aggregator status bit.
 620  * @secondary_host:     Host ID of the IRQ destination computing entity. This is
 621  *                      required only when destination host id is different
 622  *                      from ti sci interface host id.
 623  *
 624  * Request type is TI_SCI_MSG_SET/RELEASE_IRQ.
 625  * Response is generic ACK / NACK message.
 626  */
 627 struct ti_sci_msg_req_manage_irq {
 628         struct ti_sci_msg_hdr hdr;
 629 #define MSG_FLAG_DST_ID_VALID                   TI_SCI_MSG_FLAG(0)
 630 #define MSG_FLAG_DST_HOST_IRQ_VALID             TI_SCI_MSG_FLAG(1)
 631 #define MSG_FLAG_IA_ID_VALID                    TI_SCI_MSG_FLAG(2)
 632 #define MSG_FLAG_VINT_VALID                     TI_SCI_MSG_FLAG(3)
 633 #define MSG_FLAG_GLB_EVNT_VALID                 TI_SCI_MSG_FLAG(4)
 634 #define MSG_FLAG_VINT_STS_BIT_VALID             TI_SCI_MSG_FLAG(5)
 635 #define MSG_FLAG_SHOST_VALID                    TI_SCI_MSG_FLAG(31)
 636         u32 valid_params;
 637         u16 src_id;
 638         u16 src_index;
 639         u16 dst_id;
 640         u16 dst_host_irq;
 641         u16 ia_id;
 642         u16 vint;
 643         u16 global_event;
 644         u8 vint_status_bit;
 645         u8 secondary_host;
 646 } __packed;
 647
 648 /**
 649  * struct ti_sci_msg_rm_ring_cfg_req - Configure a Navigator Subsystem ring
 650  *
 651  * Configures the non-real-time registers of a Navigator Subsystem ring.
 652  * @hdr:        Generic Header
 653  * @valid_params: Bitfield defining validity of ring configuration parameters.
 654  *      The ring configuration fields are not valid, and will not be used for
 655  *      ring configuration, if their corresponding valid bit is zero.
 656  *      Valid bit usage:
 657  *      0 - Valid bit for @tisci_msg_rm_ring_cfg_req addr_lo
 658  *      1 - Valid bit for @tisci_msg_rm_ring_cfg_req addr_hi
 659  *      2 - Valid bit for @tisci_msg_rm_ring_cfg_req count
 660  *      3 - Valid bit for @tisci_msg_rm_ring_cfg_req mode
 661  *      4 - Valid bit for @tisci_msg_rm_ring_cfg_req size
 662  *      5 - Valid bit for @tisci_msg_rm_ring_cfg_req order_id
 663  * @nav_id: Device ID of Navigator Subsystem from which the ring is allocated
 664  * @index: ring index to be configured.
 665  * @addr_lo: 32 LSBs of ring base address to be programmed into the ring's
 666  *      RING_BA_LO register
 667  * @addr_hi: 16 MSBs of ring base address to be programmed into the ring's
 668  *      RING_BA_HI register.
 669  * @count: Number of ring elements. Must be even if mode is CREDENTIALS or QM
 670  *      modes.
 671  * @mode: Specifies the mode the ring is to be configured.
 672  * @size: Specifies encoded ring element size. To calculate the encoded size use
 673  *      the formula (log2(size_bytes) - 2), where size_bytes cannot be
 674  *      greater than 256.
 675  * @order_id: Specifies the ring's bus order ID.
 676  */
 677 struct ti_sci_msg_rm_ring_cfg_req {
 678         struct ti_sci_msg_hdr hdr;
 679         u32 valid_params;
 680         u16 nav_id;
 681         u16 index;
 682         u32 addr_lo;
 683         u32 addr_hi;
 684         u32 count;
 685         u8 mode;
 686         u8 size;
 687         u8 order_id;
 688 } __packed;
 689
 690 /**
 691  * struct ti_sci_msg_rm_ring_get_cfg_req - Get RA ring's configuration
 692  *
 693  * Gets the configuration of the non-real-time register fields of a ring.  The
 694  * host, or a supervisor of the host, who owns the ring must be the requesting
 695  * host.  The values of the non-real-time registers are returned in
 696  * @ti_sci_msg_rm_ring_get_cfg_resp.
 697  *
 698  * @hdr: Generic Header
 699  * @nav_id: Device ID of Navigator Subsystem from which the ring is allocated
 700  * @index: ring index.
 701  */
 702 struct ti_sci_msg_rm_ring_get_cfg_req {
 703         struct ti_sci_msg_hdr hdr;
 704         u16 nav_id;
 705         u16 index;
 706 } __packed;
 707
 708 /**
 709  * struct ti_sci_msg_rm_ring_get_cfg_resp -  Ring get configuration response
 710  *
 711  * Response received by host processor after RM has handled
 712  * @ti_sci_msg_rm_ring_get_cfg_req. The response contains the ring's
 713  * non-real-time register values.
 714  *
 715  * @hdr: Generic Header
 716  * @addr_lo: Ring 32 LSBs of base address
 717  * @addr_hi: Ring 16 MSBs of base address.
 718  * @count: Ring number of elements.
 719  * @mode: Ring mode.
 720  * @size: encoded Ring element size
 721  * @order_id: ing order ID.
 722  */
 723 struct ti_sci_msg_rm_ring_get_cfg_resp {
 724         struct ti_sci_msg_hdr hdr;
 725         u32 addr_lo;
 726         u32 addr_hi;
 727         u32 count;
 728         u8 mode;
 729         u8 size;
 730         u8 order_id;
 731 } __packed;
 732
 733 /**
 734  * struct ti_sci_msg_psil_pair - Pairs a PSI-L source thread to a destination
 735  *                               thread
 736  * @hdr:        Generic Header
 737  * @nav_id:     SoC Navigator Subsystem device ID whose PSI-L config proxy is
 738  *              used to pair the source and destination threads.
 739  * @src_thread: PSI-L source thread ID within the PSI-L System thread map.
 740  *
 741  * UDMAP transmit channels mapped to source threads will have their
 742  * TCHAN_THRD_ID register programmed with the destination thread if the pairing
 743  * is successful.
 744
 745  * @dst_thread: PSI-L destination thread ID within the PSI-L System thread map.
 746  * PSI-L destination threads start at index 0x8000.  The request is NACK'd if
 747  * the destination thread is not greater than or equal to 0x8000.
 748  *
 749  * UDMAP receive channels mapped to destination threads will have their
 750  * RCHAN_THRD_ID register programmed with the source thread if the pairing
 751  * is successful.
 752  *
 753  * Request type is TI_SCI_MSG_RM_PSIL_PAIR, response is a generic ACK or NACK
 754  * message.
 755  */
 756 struct ti_sci_msg_psil_pair {
 757         struct ti_sci_msg_hdr hdr;
 758         u32 nav_id;
 759         u32 src_thread;
 760         u32 dst_thread;
 761 } __packed;
 762
 763 /**
 764  * struct ti_sci_msg_psil_unpair - Unpairs a PSI-L source thread from a
 765  *                                 destination thread
 766  * @hdr:        Generic Header
 767  * @nav_id:     SoC Navigator Subsystem device ID whose PSI-L config proxy is
 768  *              used to unpair the source and destination threads.
 769  * @src_thread: PSI-L source thread ID within the PSI-L System thread map.
 770  *
 771  * UDMAP transmit channels mapped to source threads will have their
 772  * TCHAN_THRD_ID register cleared if the unpairing is successful.
 773  *
 774  * @dst_thread: PSI-L destination thread ID within the PSI-L System thread map.
 775  * PSI-L destination threads start at index 0x8000.  The request is NACK'd if
 776  * the destination thread is not greater than or equal to 0x8000.
 777  *
 778  * UDMAP receive channels mapped to destination threads will have their
 779  * RCHAN_THRD_ID register cleared if the unpairing is successful.
 780  *
 781  * Request type is TI_SCI_MSG_RM_PSIL_UNPAIR, response is a generic ACK or NACK
 782  * message.
 783  */
 784 struct ti_sci_msg_psil_unpair {
 785         struct ti_sci_msg_hdr hdr;
 786         u32 nav_id;
 787         u32 src_thread;
 788         u32 dst_thread;
 789 } __packed;
 790
 791 /**
 792  * struct ti_sci_msg_udmap_rx_flow_cfg -  UDMAP receive flow configuration
 793  *                                        message
 794  * @hdr: Generic Header
 795  * @nav_id: SoC Navigator Subsystem device ID from which the receive flow is
 796  *      allocated
 797  * @flow_index: UDMAP receive flow index for non-optional configuration.
 798  * @rx_ch_index: Specifies the index of the receive channel using the flow_index
 799  * @rx_einfo_present: UDMAP receive flow extended packet info present.
 800  * @rx_psinfo_present: UDMAP receive flow PS words present.
 801  * @rx_error_handling: UDMAP receive flow error handling configuration. Valid
 802  *      values are TI_SCI_RM_UDMAP_RX_FLOW_ERR_DROP/RETRY.
 803  * @rx_desc_type: UDMAP receive flow descriptor type. It can be one of
 804  *      TI_SCI_RM_UDMAP_RX_FLOW_DESC_HOST/MONO.
 805  * @rx_sop_offset: UDMAP receive flow start of packet offset.
 806  * @rx_dest_qnum: UDMAP receive flow destination queue number.
 807  * @rx_ps_location: UDMAP receive flow PS words location.
 808  *      0 - end of packet descriptor
 809  *      1 - Beginning of the data buffer
 810  * @rx_src_tag_hi: UDMAP receive flow source tag high byte constant
 811  * @rx_src_tag_lo: UDMAP receive flow source tag low byte constant
 812  * @rx_dest_tag_hi: UDMAP receive flow destination tag high byte constant
 813  * @rx_dest_tag_lo: UDMAP receive flow destination tag low byte constant
 814  * @rx_src_tag_hi_sel: UDMAP receive flow source tag high byte selector
 815  * @rx_src_tag_lo_sel: UDMAP receive flow source tag low byte selector
 816  * @rx_dest_tag_hi_sel: UDMAP receive flow destination tag high byte selector
 817  * @rx_dest_tag_lo_sel: UDMAP receive flow destination tag low byte selector
 818  * @rx_size_thresh_en: UDMAP receive flow packet size based free buffer queue
 819  *      enable. If enabled, the ti_sci_rm_udmap_rx_flow_opt_cfg also need to be
 820  *      configured and sent.
 821  * @rx_fdq0_sz0_qnum: UDMAP receive flow free descriptor queue 0.
 822  * @rx_fdq1_qnum: UDMAP receive flow free descriptor queue 1.
 823  * @rx_fdq2_qnum: UDMAP receive flow free descriptor queue 2.
 824  * @rx_fdq3_qnum: UDMAP receive flow free descriptor queue 3.
 825  *
 826  * For detailed information on the settings, see the UDMAP section of the TRM.
 827  */
 828 struct ti_sci_msg_udmap_rx_flow_cfg {
 829         struct ti_sci_msg_hdr hdr;
 830         u32 nav_id;
 831         u32 flow_index;
 832         u32 rx_ch_index;
 833         u8 rx_einfo_present;
 834         u8 rx_psinfo_present;
 835         u8 rx_error_handling;
 836         u8 rx_desc_type;
 837         u16 rx_sop_offset;
 838         u16 rx_dest_qnum;
 839         u8 rx_ps_location;
 840         u8 rx_src_tag_hi;
 841         u8 rx_src_tag_lo;
 842         u8 rx_dest_tag_hi;
 843         u8 rx_dest_tag_lo;
 844         u8 rx_src_tag_hi_sel;
 845         u8 rx_src_tag_lo_sel;
 846         u8 rx_dest_tag_hi_sel;
 847         u8 rx_dest_tag_lo_sel;
 848         u8 rx_size_thresh_en;
 849         u16 rx_fdq0_sz0_qnum;
 850         u16 rx_fdq1_qnum;
 851         u16 rx_fdq2_qnum;
 852         u16 rx_fdq3_qnum;
 853 } __packed;
 854
 855 /**
 856  * struct rm_ti_sci_msg_udmap_rx_flow_opt_cfg - parameters for UDMAP receive
 857  *                                              flow optional configuration
 858  * @hdr: Generic Header
 859  * @nav_id: SoC Navigator Subsystem device ID from which the receive flow is
 860  *      allocated
 861  * @flow_index: UDMAP receive flow index for optional configuration.
 862  * @rx_ch_index: Specifies the index of the receive channel using the flow_index
 863  * @rx_size_thresh0: UDMAP receive flow packet size threshold 0.
 864  * @rx_size_thresh1: UDMAP receive flow packet size threshold 1.
 865  * @rx_size_thresh2: UDMAP receive flow packet size threshold 2.
 866  * @rx_fdq0_sz1_qnum: UDMAP receive flow free descriptor queue for size
 867  *      threshold 1.
 868  * @rx_fdq0_sz2_qnum: UDMAP receive flow free descriptor queue for size
 869  *      threshold 2.
 870  * @rx_fdq0_sz3_qnum: UDMAP receive flow free descriptor queue for size
 871  *      threshold 3.
 872  *
 873  * For detailed information on the settings, see the UDMAP section of the TRM.
 874  */
 875 struct rm_ti_sci_msg_udmap_rx_flow_opt_cfg {
 876         struct ti_sci_msg_hdr hdr;
 877         u32 nav_id;
 878         u32 flow_index;
 879         u32 rx_ch_index;
 880         u16 rx_size_thresh0;
 881         u16 rx_size_thresh1;
 882         u16 rx_size_thresh2;
 883         u16 rx_fdq0_sz1_qnum;
 884         u16 rx_fdq0_sz2_qnum;
 885         u16 rx_fdq0_sz3_qnum;
 886 } __packed;
 887
 888 /**
 889  * Configures a Navigator Subsystem UDMAP transmit channel
 890  *
 891  * Configures the non-real-time registers of a Navigator Subsystem UDMAP
 892  * transmit channel.  The channel index must be assigned to the host defined
 893  * in the TISCI header via the RM board configuration resource assignment
 894  * range list.
 895  *
 896  * @hdr: Generic Header
 897  *
 898  * @valid_params: Bitfield defining validity of tx channel configuration
 899  * parameters. The tx channel configuration fields are not valid, and will not
 900  * be used for ch configuration, if their corresponding valid bit is zero.
 901  * Valid bit usage:
 902  *    0 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::tx_pause_on_err
 903  *    1 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::tx_atype
 904  *    2 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::tx_chan_type
 905  *    3 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::tx_fetch_size
 906  *    4 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::txcq_qnum
 907  *    5 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::tx_priority
 908  *    6 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::tx_qos
 909  *    7 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::tx_orderid
 910  *    8 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::tx_sched_priority
 911  *    9 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::tx_filt_einfo
 912  *   10 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::tx_filt_pswords
 913  *   11 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::tx_supr_tdpkt
 914  *   12 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::tx_credit_count
 915  *   13 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::fdepth
 916  *   14 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::tx_burst_size
 917  *   15 - Valid bit for @ref ti_sci_msg_rm_udmap_tx_ch_cfg::tx_tdtype
 918  *
 919  * @nav_id: SoC device ID of Navigator Subsystem where tx channel is located
 920  *
 921  * @index: UDMAP transmit channel index.
 922  *
 923  * @tx_pause_on_err: UDMAP transmit channel pause on error configuration to
 924  * be programmed into the tx_pause_on_err field of the channel's TCHAN_TCFG
 925  * register.
 926  *
 927  * @tx_filt_einfo: UDMAP transmit channel extended packet information passing
 928  * configuration to be programmed into the tx_filt_einfo field of the
 929  * channel's TCHAN_TCFG register.
 930  *
 931  * @tx_filt_pswords: UDMAP transmit channel protocol specific word passing
 932  * configuration to be programmed into the tx_filt_pswords field of the
 933  * channel's TCHAN_TCFG register.
 934  *
 935  * @tx_atype: UDMAP transmit channel non Ring Accelerator access pointer
 936  * interpretation configuration to be programmed into the tx_atype field of
 937  * the channel's TCHAN_TCFG register.
 938  *
 939  * @tx_chan_type: UDMAP transmit channel functional channel type and work
 940  * passing mechanism configuration to be programmed into the tx_chan_type
 941  * field of the channel's TCHAN_TCFG register.
 942  *
 943  * @tx_supr_tdpkt: UDMAP transmit channel teardown packet generation suppression
 944  * configuration to be programmed into the tx_supr_tdpkt field of the channel's
 945  * TCHAN_TCFG register.
 946  *
 947  * @tx_fetch_size: UDMAP transmit channel number of 32-bit descriptor words to
 948  * fetch configuration to be programmed into the tx_fetch_size field of the
 949  * channel's TCHAN_TCFG register.  The user must make sure to set the maximum
 950  * word count that can pass through the channel for any allowed descriptor type.
 951  *
 952  * @tx_credit_count: UDMAP transmit channel transfer request credit count
 953  * configuration to be programmed into the count field of the TCHAN_TCREDIT
 954  * register.  Specifies how many credits for complete TRs are available.
 955  *
 956  * @txcq_qnum: UDMAP transmit channel completion queue configuration to be
 957  * programmed into the txcq_qnum field of the TCHAN_TCQ register. The specified
 958  * completion queue must be assigned to the host, or a subordinate of the host,
 959  * requesting configuration of the transmit channel.
 960  *
 961  * @tx_priority: UDMAP transmit channel transmit priority value to be programmed
 962  * into the priority field of the channel's TCHAN_TPRI_CTRL register.
 963  *
 964  * @tx_qos: UDMAP transmit channel transmit qos value to be programmed into the
 965  * qos field of the channel's TCHAN_TPRI_CTRL register.
 966  *
 967  * @tx_orderid: UDMAP transmit channel bus order id value to be programmed into
 968  * the orderid field of the channel's TCHAN_TPRI_CTRL register.
 969  *
 970  * @fdepth: UDMAP transmit channel FIFO depth configuration to be programmed
 971  * into the fdepth field of the TCHAN_TFIFO_DEPTH register. Sets the number of
 972  * Tx FIFO bytes which are allowed to be stored for the channel. Check the UDMAP
 973  * section of the TRM for restrictions regarding this parameter.
 974  *
 975  * @tx_sched_priority: UDMAP transmit channel tx scheduling priority
 976  * configuration to be programmed into the priority field of the channel's
 977  * TCHAN_TST_SCHED register.
 978  *
 979  * @tx_burst_size: UDMAP transmit channel burst size configuration to be
 980  * programmed into the tx_burst_size field of the TCHAN_TCFG register.
 981  *
 982  * @tx_tdtype: UDMAP transmit channel teardown type configuration to be
 983  * programmed into the tdtype field of the TCHAN_TCFG register:
 984  * 0 - Return immediately
 985  * 1 - Wait for completion message from remote peer
 986  */
 987 struct ti_sci_msg_rm_udmap_tx_ch_cfg_req {
 988         struct ti_sci_msg_hdr hdr;
 989         u32 valid_params;
 990         u16 nav_id;
 991         u16 index;
 992         u8 tx_pause_on_err;
 993         u8 tx_filt_einfo;
 994         u8 tx_filt_pswords;
 995         u8 tx_atype;
 996         u8 tx_chan_type;
 997         u8 tx_supr_tdpkt;
 998         u16 tx_fetch_size;
 999         u8 tx_credit_count;
1000         u16 txcq_qnum;
1001         u8 tx_priority;
1002         u8 tx_qos;
1003         u8 tx_orderid;
1004         u16 fdepth;
1005         u8 tx_sched_priority;
1006         u8 tx_burst_size;
1007         u8 tx_tdtype;
1008 } __packed;
1009
1010 /**
1011  * Configures a Navigator Subsystem UDMAP receive channel
1012  *
1013  * Configures the non-real-time registers of a Navigator Subsystem UDMAP
1014  * receive channel.  The channel index must be assigned to the host defined
1015  * in the TISCI header via the RM board configuration resource assignment
1016  * range list.
1017  *
1018  * @hdr: Generic Header
1019  *
1020  * @valid_params: Bitfield defining validity of rx channel configuration
1021  * parameters.
1022  * The rx channel configuration fields are not valid, and will not be used for
1023  * ch configuration, if their corresponding valid bit is zero.
1024  * Valid bit usage:
1025  *    0 - Valid bit for @ti_sci_msg_rm_udmap_rx_ch_cfg_req::rx_pause_on_err
1026  *    1 - Valid bit for @ti_sci_msg_rm_udmap_rx_ch_cfg_req::rx_atype
1027  *    2 - Valid bit for @ti_sci_msg_rm_udmap_rx_ch_cfg_req::rx_chan_type
1028  *    3 - Valid bit for @ti_sci_msg_rm_udmap_rx_ch_cfg_req::rx_fetch_size
1029  *    4 - Valid bit for @ti_sci_msg_rm_udmap_rx_ch_cfg_req::rxcq_qnum
1030  *    5 - Valid bit for @ti_sci_msg_rm_udmap_rx_ch_cfg_req::rx_priority
1031  *    6 - Valid bit for @ti_sci_msg_rm_udmap_rx_ch_cfg_req::rx_qos
1032  *    7 - Valid bit for @ti_sci_msg_rm_udmap_rx_ch_cfg_req::rx_orderid
1033  *    8 - Valid bit for @ti_sci_msg_rm_udmap_rx_ch_cfg_req::rx_sched_priority
1034  *    9 - Valid bit for @ti_sci_msg_rm_udmap_rx_ch_cfg_req::flowid_start
1035  *   10 - Valid bit for @ti_sci_msg_rm_udmap_rx_ch_cfg_req::flowid_cnt
1036  *   11 - Valid bit for @ti_sci_msg_rm_udmap_rx_ch_cfg_req::rx_ignore_short
1037  *   12 - Valid bit for @ti_sci_msg_rm_udmap_rx_ch_cfg_req::rx_ignore_long
1038  *   14 - Valid bit for @ti_sci_msg_rm_udmap_rx_ch_cfg_req::rx_burst_size
1039  *
1040  * @nav_id: SoC device ID of Navigator Subsystem where rx channel is located
1041  *
1042  * @index: UDMAP receive channel index.
1043  *
1044  * @rx_fetch_size: UDMAP receive channel number of 32-bit descriptor words to
1045  * fetch configuration to be programmed into the rx_fetch_size field of the
1046  * channel's RCHAN_RCFG register.
1047  *
1048  * @rxcq_qnum: UDMAP receive channel completion queue configuration to be
1049  * programmed into the rxcq_qnum field of the RCHAN_RCQ register.
1050  * The specified completion queue must be assigned to the host, or a subordinate
1051  * of the host, requesting configuration of the receive channel.
1052  *
1053  * @rx_priority: UDMAP receive channel receive priority value to be programmed
1054  * into the priority field of the channel's RCHAN_RPRI_CTRL register.
1055  *
1056  * @rx_qos: UDMAP receive channel receive qos value to be programmed into the
1057  * qos field of the channel's RCHAN_RPRI_CTRL register.
1058  *
1059  * @rx_orderid: UDMAP receive channel bus order id value to be programmed into
1060  * the orderid field of the channel's RCHAN_RPRI_CTRL register.
1061  *
1062  * @rx_sched_priority: UDMAP receive channel rx scheduling priority
1063  * configuration to be programmed into the priority field of the channel's
1064  * RCHAN_RST_SCHED register.
1065  *
1066  * @flowid_start: UDMAP receive channel additional flows starting index
1067  * configuration to program into the flow_start field of the RCHAN_RFLOW_RNG
1068  * register. Specifies the starting index for flow IDs the receive channel is to
1069  * make use of beyond the default flow. flowid_start and @ref flowid_cnt must be
1070  * set as valid and configured together. The starting flow ID set by
1071  * @ref flowid_cnt must be a flow index within the Navigator Subsystem's subset
1072  * of flows beyond the default flows statically mapped to receive channels.
1073  * The additional flows must be assigned to the host, or a subordinate of the
1074  * host, requesting configuration of the receive channel.
1075  *
1076  * @flowid_cnt: UDMAP receive channel additional flows count configuration to
1077  * program into the flowid_cnt field of the RCHAN_RFLOW_RNG register.
1078  * This field specifies how many flow IDs are in the additional contiguous range
1079  * of legal flow IDs for the channel.  @ref flowid_start and flowid_cnt must be
1080  * set as valid and configured together. Disabling the valid_params field bit
1081  * for flowid_cnt indicates no flow IDs other than the default are to be
1082  * allocated and used by the receive channel. @ref flowid_start plus flowid_cnt
1083  * cannot be greater than the number of receive flows in the receive channel's
1084  * Navigator Subsystem.  The additional flows must be assigned to the host, or a
1085  * subordinate of the host, requesting configuration of the receive channel.
1086  *
1087  * @rx_pause_on_err: UDMAP receive channel pause on error configuration to be
1088  * programmed into the rx_pause_on_err field of the channel's RCHAN_RCFG
1089  * register.
1090  *
1091  * @rx_atype: UDMAP receive channel non Ring Accelerator access pointer
1092  * interpretation configuration to be programmed into the rx_atype field of the
1093  * channel's RCHAN_RCFG register.
1094  *
1095  * @rx_chan_type: UDMAP receive channel functional channel type and work passing
1096  * mechanism configuration to be programmed into the rx_chan_type field of the
1097  * channel's RCHAN_RCFG register.
1098  *
1099  * @rx_ignore_short: UDMAP receive channel short packet treatment configuration
1100  * to be programmed into the rx_ignore_short field of the RCHAN_RCFG register.
1101  *
1102  * @rx_ignore_long: UDMAP receive channel long packet treatment configuration to
1103  * be programmed into the rx_ignore_long field of the RCHAN_RCFG register.
1104  *
1105  * @rx_burst_size: UDMAP receive channel burst size configuration to be
1106  * programmed into the rx_burst_size field of the RCHAN_RCFG register.
1107  */
1108 struct ti_sci_msg_rm_udmap_rx_ch_cfg_req {
1109         struct ti_sci_msg_hdr hdr;
1110         u32 valid_params;
1111         u16 nav_id;
1112         u16 index;
1113         u16 rx_fetch_size;
1114         u16 rxcq_qnum;
1115         u8 rx_priority;
1116         u8 rx_qos;
1117         u8 rx_orderid;
1118         u8 rx_sched_priority;
1119         u16 flowid_start;
1120         u16 flowid_cnt;
1121         u8 rx_pause_on_err;
1122         u8 rx_atype;
1123         u8 rx_chan_type;
1124         u8 rx_ignore_short;
1125         u8 rx_ignore_long;
1126         u8 rx_burst_size;
1127 } __packed;
1128
1129 /**
1130  * Configures a Navigator Subsystem UDMAP receive flow
1131  *
1132  * Configures a Navigator Subsystem UDMAP receive flow's registers.
1133  * Configuration does not include the flow registers which handle size-based
1134  * free descriptor queue routing.
1135  *
1136  * The flow index must be assigned to the host defined in the TISCI header via
1137  * the RM board configuration resource assignment range list.
1138  *
1139  * @hdr: Standard TISCI header
1140  *
1141  * @valid_params
1142  * Bitfield defining validity of rx flow configuration parameters.  The
1143  * rx flow configuration fields are not valid, and will not be used for flow
1144  * configuration, if their corresponding valid bit is zero.  Valid bit usage:
1145  *     0 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_einfo_present
1146  *     1 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_psinfo_present
1147  *     2 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_error_handling
1148  *     3 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_desc_type
1149  *     4 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_sop_offset
1150  *     5 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_dest_qnum
1151  *     6 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_src_tag_hi
1152  *     7 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_src_tag_lo
1153  *     8 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_dest_tag_hi
1154  *     9 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_dest_tag_lo
1155  *    10 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_src_tag_hi_sel
1156  *    11 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_src_tag_lo_sel
1157  *    12 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_dest_tag_hi_sel
1158  *    13 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_dest_tag_lo_sel
1159  *    14 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_fdq0_sz0_qnum
1160  *    15 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_fdq1_sz0_qnum
1161  *    16 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_fdq2_sz0_qnum
1162  *    17 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_fdq3_sz0_qnum
1163  *    18 - Valid bit for @tisci_msg_rm_udmap_flow_cfg_req::rx_ps_location
1164  *
1165  * @nav_id: SoC device ID of Navigator Subsystem from which the receive flow is
1166  * allocated
1167  *
1168  * @flow_index: UDMAP receive flow index for non-optional configuration.
1169  *
1170  * @rx_einfo_present:
1171  * UDMAP receive flow extended packet info present configuration to be
1172  * programmed into the rx_einfo_present field of the flow's RFLOW_RFA register.
1173  *
1174  * @rx_psinfo_present:
1175  * UDMAP receive flow PS words present configuration to be programmed into the
1176  * rx_psinfo_present field of the flow's RFLOW_RFA register.
1177  *
1178  * @rx_error_handling:
1179  * UDMAP receive flow error handling configuration to be programmed into the
1180  * rx_error_handling field of the flow's RFLOW_RFA register.
1181  *
1182  * @rx_desc_type:
1183  * UDMAP receive flow descriptor type configuration to be programmed into the
1184  * rx_desc_type field field of the flow's RFLOW_RFA register.
1185  *
1186  * @rx_sop_offset:
1187  * UDMAP receive flow start of packet offset configuration to be programmed
1188  * into the rx_sop_offset field of the RFLOW_RFA register.  See the UDMAP
1189  * section of the TRM for more information on this setting.  Valid values for
1190  * this field are 0-255 bytes.
1191  *
1192  * @rx_dest_qnum:
1193  * UDMAP receive flow destination queue configuration to be programmed into the
1194  * rx_dest_qnum field of the flow's RFLOW_RFA register.  The specified
1195  * destination queue must be valid within the Navigator Subsystem and must be
1196  * owned by the host, or a subordinate of the host, requesting allocation and
1197  * configuration of the receive flow.
1198  *
1199  * @rx_src_tag_hi:
1200  * UDMAP receive flow source tag high byte constant configuration to be
1201  * programmed into the rx_src_tag_hi field of the flow's RFLOW_RFB register.
1202  * See the UDMAP section of the TRM for more information on this setting.
1203  *
1204  * @rx_src_tag_lo:
1205  * UDMAP receive flow source tag low byte constant configuration to be
1206  * programmed into the rx_src_tag_lo field of the flow's RFLOW_RFB register.
1207  * See the UDMAP section of the TRM for more information on this setting.
1208  *
1209  * @rx_dest_tag_hi:
1210  * UDMAP receive flow destination tag high byte constant configuration to be
1211  * programmed into the rx_dest_tag_hi field of the flow's RFLOW_RFB register.
1212  * See the UDMAP section of the TRM for more information on this setting.
1213  *
1214  * @rx_dest_tag_lo:
1215  * UDMAP receive flow destination tag low byte constant configuration to be
1216  * programmed into the rx_dest_tag_lo field of the flow's RFLOW_RFB register.
1217  * See the UDMAP section of the TRM for more information on this setting.
1218  *
1219  * @rx_src_tag_hi_sel:
1220  * UDMAP receive flow source tag high byte selector configuration to be
1221  * programmed into the rx_src_tag_hi_sel field of the RFLOW_RFC register.  See
1222  * the UDMAP section of the TRM for more information on this setting.
1223  *
1224  * @rx_src_tag_lo_sel:
1225  * UDMAP receive flow source tag low byte selector configuration to be
1226  * programmed into the rx_src_tag_lo_sel field of the RFLOW_RFC register.  See
1227  * the UDMAP section of the TRM for more information on this setting.
1228  *
1229  * @rx_dest_tag_hi_sel:
1230  * UDMAP receive flow destination tag high byte selector configuration to be
1231  * programmed into the rx_dest_tag_hi_sel field of the RFLOW_RFC register.  See
1232  * the UDMAP section of the TRM for more information on this setting.
1233  *
1234  * @rx_dest_tag_lo_sel:
1235  * UDMAP receive flow destination tag low byte selector configuration to be
1236  * programmed into the rx_dest_tag_lo_sel field of the RFLOW_RFC register.  See
1237  * the UDMAP section of the TRM for more information on this setting.
1238  *
1239  * @rx_fdq0_sz0_qnum:
1240  * UDMAP receive flow free descriptor queue 0 configuration to be programmed
1241  * into the rx_fdq0_sz0_qnum field of the flow's RFLOW_RFD register.  See the
1242  * UDMAP section of the TRM for more information on this setting. The specified
1243  * free queue must be valid within the Navigator Subsystem and must be owned
1244  * by the host, or a subordinate of the host, requesting allocation and
1245  * configuration of the receive flow.
1246  *
1247  * @rx_fdq1_qnum:
1248  * UDMAP receive flow free descriptor queue 1 configuration to be programmed
1249  * into the rx_fdq1_qnum field of the flow's RFLOW_RFD register.  See the
1250  * UDMAP section of the TRM for more information on this setting.  The specified
1251  * free queue must be valid within the Navigator Subsystem and must be owned
1252  * by the host, or a subordinate of the host, requesting allocation and
1253  * configuration of the receive flow.
1254  *
1255  * @rx_fdq2_qnum:
1256  * UDMAP receive flow free descriptor queue 2 configuration to be programmed
1257  * into the rx_fdq2_qnum field of the flow's RFLOW_RFE register.  See the
1258  * UDMAP section of the TRM for more information on this setting.  The specified
1259  * free queue must be valid within the Navigator Subsystem and must be owned
1260  * by the host, or a subordinate of the host, requesting allocation and
1261  * configuration of the receive flow.
1262  *
1263  * @rx_fdq3_qnum:
1264  * UDMAP receive flow free descriptor queue 3 configuration to be programmed
1265  * into the rx_fdq3_qnum field of the flow's RFLOW_RFE register.  See the
1266  * UDMAP section of the TRM for more information on this setting.  The specified
1267  * free queue must be valid within the Navigator Subsystem and must be owned
1268  * by the host, or a subordinate of the host, requesting allocation and
1269  * configuration of the receive flow.
1270  *
1271  * @rx_ps_location:
1272  * UDMAP receive flow PS words location configuration to be programmed into the
1273  * rx_ps_location field of the flow's RFLOW_RFA register.
1274  */
1275 struct ti_sci_msg_rm_udmap_flow_cfg_req {
1276         struct ti_sci_msg_hdr hdr;
1277         u32 valid_params;
1278         u16 nav_id;
1279         u16 flow_index;
1280         u8 rx_einfo_present;
1281         u8 rx_psinfo_present;
1282         u8 rx_error_handling;
1283         u8 rx_desc_type;
1284         u16 rx_sop_offset;
1285         u16 rx_dest_qnum;
1286         u8 rx_src_tag_hi;
1287         u8 rx_src_tag_lo;
1288         u8 rx_dest_tag_hi;
1289         u8 rx_dest_tag_lo;
1290         u8 rx_src_tag_hi_sel;
1291         u8 rx_src_tag_lo_sel;
1292         u8 rx_dest_tag_hi_sel;
1293         u8 rx_dest_tag_lo_sel;
1294         u16 rx_fdq0_sz0_qnum;
1295         u16 rx_fdq1_qnum;
1296         u16 rx_fdq2_qnum;
1297         u16 rx_fdq3_qnum;
1298         u8 rx_ps_location;
1299 } __packed;
1300
1301 /**
1302  * struct ti_sci_msg_req_proc_request - Request a processor
1303  * @hdr:                Generic Header
1304  * @processor_id:       ID of processor being requested
1305  *
1306  * Request type is TI_SCI_MSG_PROC_REQUEST, response is a generic ACK/NACK
1307  * message.
1308  */
1309 struct ti_sci_msg_req_proc_request {
1310         struct ti_sci_msg_hdr hdr;
1311         u8 processor_id;
1312 } __packed;
1313
1314 /**
1315  * struct ti_sci_msg_req_proc_release - Release a processor
1316  * @hdr:                Generic Header
1317  * @processor_id:       ID of processor being released
1318  *
1319  * Request type is TI_SCI_MSG_PROC_RELEASE, response is a generic ACK/NACK
1320  * message.
1321  */
1322 struct ti_sci_msg_req_proc_release {
1323         struct ti_sci_msg_hdr hdr;
1324         u8 processor_id;
1325 } __packed;
1326
1327 /**
1328  * struct ti_sci_msg_req_proc_handover - Handover a processor to a host
1329  * @hdr:                Generic Header
1330  * @processor_id:       ID of processor being handed over
1331  * @host_id:            Host ID the control needs to be transferred to
1332  *
1333  * Request type is TI_SCI_MSG_PROC_HANDOVER, response is a generic ACK/NACK
1334  * message.
1335  */
1336 struct ti_sci_msg_req_proc_handover {
1337         struct ti_sci_msg_hdr hdr;
1338         u8 processor_id;
1339         u8 host_id;
1340 } __packed;
1341
1342 /* Boot Vector masks */
1343 #define TI_SCI_ADDR_LOW_MASK                    GENMASK_ULL(31, 0)
1344 #define TI_SCI_ADDR_HIGH_MASK                   GENMASK_ULL(63, 32)
1345 #define TI_SCI_ADDR_HIGH_SHIFT                  32
1346
1347 /**
1348  * struct ti_sci_msg_req_set_config - Set Processor boot configuration
1349  * @hdr:                Generic Header
1350  * @processor_id:       ID of processor being configured
1351  * @bootvector_low:     Lower 32 bit address (Little Endian) of boot vector
1352  * @bootvector_high:    Higher 32 bit address (Little Endian) of boot vector
1353  * @config_flags_set:   Optional Processor specific Config Flags to set.
1354  *                      Setting a bit here implies the corresponding mode
1355  *                      will be set
1356  * @config_flags_clear: Optional Processor specific Config Flags to clear.
1357  *                      Setting a bit here implies the corresponding mode
1358  *                      will be cleared
1359  *
1360  * Request type is TI_SCI_MSG_PROC_HANDOVER, response is a generic ACK/NACK
1361  * message.
1362  */
1363 struct ti_sci_msg_req_set_config {
1364         struct ti_sci_msg_hdr hdr;
1365         u8 processor_id;
1366         u32 bootvector_low;
1367         u32 bootvector_high;
1368         u32 config_flags_set;
1369         u32 config_flags_clear;
1370 } __packed;
1371
1372 /**
1373  * struct ti_sci_msg_req_set_ctrl - Set Processor boot control flags
1374  * @hdr:                Generic Header
1375  * @processor_id:       ID of processor being configured
1376  * @control_flags_set:  Optional Processor specific Control Flags to set.
1377  *                      Setting a bit here implies the corresponding mode
1378  *                      will be set
1379  * @control_flags_clear:Optional Processor specific Control Flags to clear.
1380  *                      Setting a bit here implies the corresponding mode
1381  *                      will be cleared
1382  *
1383  * Request type is TI_SCI_MSG_SET_CTRL, response is a generic ACK/NACK
1384  * message.
1385  */
1386 struct ti_sci_msg_req_set_ctrl {
1387         struct ti_sci_msg_hdr hdr;
1388         u8 processor_id;
1389         u32 control_flags_set;
1390         u32 control_flags_clear;
1391 } __packed;
1392
1393 /**
1394  * struct ti_sci_msg_req_get_status - Processor boot status request
1395  * @hdr:                Generic Header
1396  * @processor_id:       ID of processor whose status is being requested
1397  *
1398  * Request type is TI_SCI_MSG_GET_STATUS, response is an appropriate
1399  * message, or NACK in case of inability to satisfy request.
1400  */
1401 struct ti_sci_msg_req_get_status {
1402         struct ti_sci_msg_hdr hdr;
1403         u8 processor_id;
1404 } __packed;
1405
1406 /**
1407  * struct ti_sci_msg_resp_get_status - Processor boot status response
1408  * @hdr:                Generic Header
1409  * @processor_id:       ID of processor whose status is returned
1410  * @bootvector_low:     Lower 32 bit address (Little Endian) of boot vector
1411  * @bootvector_high:    Higher 32 bit address (Little Endian) of boot vector
1412  * @config_flags:       Optional Processor specific Config Flags set currently
1413  * @control_flags:      Optional Processor specific Control Flags set currently
1414  * @status_flags:       Optional Processor specific Status Flags set currently
1415  *
1416  * Response structure to a TI_SCI_MSG_GET_STATUS request.
1417  */
1418 struct ti_sci_msg_resp_get_status {
1419         struct ti_sci_msg_hdr hdr;
1420         u8 processor_id;
1421         u32 bootvector_low;
1422         u32 bootvector_high;
1423         u32 config_flags;
1424         u32 control_flags;
1425         u32 status_flags;
1426 } __packed;
1427
1428 #endif /* __TI_SCI_H */