1 // SPDX-License-Identifier: GPL-2.0
3 * Texas Instruments System Control Interface Protocol Driver
5 * Copyright (C) 2015-2016 Texas Instruments Incorporated - http://www.ti.com/
9 #define pr_fmt(fmt) "%s: " fmt, __func__
11 #include <linux/bitmap.h>
12 #include <linux/debugfs.h>
13 #include <linux/export.h>
15 #include <linux/kernel.h>
16 #include <linux/mailbox_client.h>
17 #include <linux/module.h>
18 #include <linux/of_device.h>
19 #include <linux/semaphore.h>
20 #include <linux/slab.h>
21 #include <linux/soc/ti/ti-msgmgr.h>
22 #include <linux/soc/ti/ti_sci_protocol.h>
23 #include <linux/reboot.h>
27 /* List of all TI SCI devices active in system */
28 static LIST_HEAD(ti_sci_list);
29 /* Protection for the entire list */
30 static DEFINE_MUTEX(ti_sci_list_mutex);
33 * struct ti_sci_xfer - Structure representing a message flow
34 * @tx_message: Transmit message
35 * @rx_len: Receive message length
36 * @xfer_buf: Preallocated buffer to store receive message
37 * Since we work with request-ACK protocol, we can
38 * reuse the same buffer for the rx path as we
39 * use for the tx path.
40 * @done: completion event
43 struct ti_msgmgr_message tx_message;
46 struct completion done;
50 * struct ti_sci_xfers_info - Structure to manage transfer information
51 * @sem_xfer_count: Counting Semaphore for managing max simultaneous
53 * @xfer_block: Preallocated Message array
54 * @xfer_alloc_table: Bitmap table for allocated messages.
55 * Index of this bitmap table is also used for message
56 * sequence identifier.
57 * @xfer_lock: Protection for message allocation
59 struct ti_sci_xfers_info {
60 struct semaphore sem_xfer_count;
61 struct ti_sci_xfer *xfer_block;
62 unsigned long *xfer_alloc_table;
63 /* protect transfer allocation */
68 * struct ti_sci_rm_type_map - Structure representing TISCI Resource
69 * management representation of dev_ids.
70 * @dev_id: TISCI device ID
71 * @type: Corresponding id as identified by TISCI RM.
73 * Note: This is used only as a work around for using RM range apis
74 * for AM654 SoC. For future SoCs dev_id will be used as type
75 * for RM range APIs. In order to maintain ABI backward compatibility
76 * type is not being changed for AM654 SoC.
78 struct ti_sci_rm_type_map {
84 * struct ti_sci_desc - Description of SoC integration
85 * @default_host_id: Host identifier representing the compute entity
86 * @max_rx_timeout_ms: Timeout for communication with SoC (in Milliseconds)
87 * @max_msgs: Maximum number of messages that can be pending
88 * simultaneously in the system
89 * @max_msg_size: Maximum size of data per message that can be handled.
90 * @rm_type_map: RM resource type mapping structure.
94 int max_rx_timeout_ms;
97 struct ti_sci_rm_type_map *rm_type_map;
101 * struct ti_sci_info - Structure representing a TI SCI instance
102 * @dev: Device pointer
103 * @desc: SoC description for this instance
104 * @nb: Reboot Notifier block
105 * @d: Debugfs file entry
106 * @debug_region: Memory region where the debug message are available
107 * @debug_region_size: Debug region size
108 * @debug_buffer: Buffer allocated to copy debug messages.
109 * @handle: Instance of TI SCI handle to send to clients.
110 * @cl: Mailbox Client
111 * @chan_tx: Transmit mailbox channel
112 * @chan_rx: Receive mailbox channel
113 * @minfo: Message info
116 * @users: Number of users of this instance
120 struct notifier_block nb;
121 const struct ti_sci_desc *desc;
123 void __iomem *debug_region;
125 size_t debug_region_size;
126 struct ti_sci_handle handle;
127 struct mbox_client cl;
128 struct mbox_chan *chan_tx;
129 struct mbox_chan *chan_rx;
130 struct ti_sci_xfers_info minfo;
131 struct list_head node;
133 /* protected by ti_sci_list_mutex */
138 #define cl_to_ti_sci_info(c) container_of(c, struct ti_sci_info, cl)
139 #define handle_to_ti_sci_info(h) container_of(h, struct ti_sci_info, handle)
140 #define reboot_to_ti_sci_info(n) container_of(n, struct ti_sci_info, nb)
142 #ifdef CONFIG_DEBUG_FS
145 * ti_sci_debug_show() - Helper to dump the debug log
146 * @s: sequence file pointer
151 static int ti_sci_debug_show(struct seq_file *s, void *unused)
153 struct ti_sci_info *info = s->private;
155 memcpy_fromio(info->debug_buffer, info->debug_region,
156 info->debug_region_size);
158 * We don't trust firmware to leave NULL terminated last byte (hence
159 * we have allocated 1 extra 0 byte). Since we cannot guarantee any
160 * specific data format for debug messages, We just present the data
161 * in the buffer as is - we expect the messages to be self explanatory.
163 seq_puts(s, info->debug_buffer);
167 /* Provide the log file operations interface*/
168 DEFINE_SHOW_ATTRIBUTE(ti_sci_debug);
171 * ti_sci_debugfs_create() - Create log debug file
172 * @pdev: platform device pointer
173 * @info: Pointer to SCI entity information
175 * Return: 0 if all went fine, else corresponding error.
177 static int ti_sci_debugfs_create(struct platform_device *pdev,
178 struct ti_sci_info *info)
180 struct device *dev = &pdev->dev;
181 struct resource *res;
182 char debug_name[50] = "ti_sci_debug@";
184 /* Debug region is optional */
185 res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
187 info->debug_region = devm_ioremap_resource(dev, res);
188 if (IS_ERR(info->debug_region))
190 info->debug_region_size = resource_size(res);
192 info->debug_buffer = devm_kcalloc(dev, info->debug_region_size + 1,
193 sizeof(char), GFP_KERNEL);
194 if (!info->debug_buffer)
196 /* Setup NULL termination */
197 info->debug_buffer[info->debug_region_size] = 0;
199 info->d = debugfs_create_file(strncat(debug_name, dev_name(dev),
201 sizeof("ti_sci_debug@")),
202 0444, NULL, info, &ti_sci_debug_fops);
204 return PTR_ERR(info->d);
206 dev_dbg(dev, "Debug region => %p, size = %zu bytes, resource: %pr\n",
207 info->debug_region, info->debug_region_size, res);
212 * ti_sci_debugfs_destroy() - clean up log debug file
213 * @pdev: platform device pointer
214 * @info: Pointer to SCI entity information
216 static void ti_sci_debugfs_destroy(struct platform_device *pdev,
217 struct ti_sci_info *info)
219 if (IS_ERR(info->debug_region))
222 debugfs_remove(info->d);
224 #else /* CONFIG_DEBUG_FS */
225 static inline int ti_sci_debugfs_create(struct platform_device *dev,
226 struct ti_sci_info *info)
231 static inline void ti_sci_debugfs_destroy(struct platform_device *dev,
232 struct ti_sci_info *info)
235 #endif /* CONFIG_DEBUG_FS */
238 * ti_sci_dump_header_dbg() - Helper to dump a message header.
239 * @dev: Device pointer corresponding to the SCI entity
240 * @hdr: pointer to header.
242 static inline void ti_sci_dump_header_dbg(struct device *dev,
243 struct ti_sci_msg_hdr *hdr)
245 dev_dbg(dev, "MSGHDR:type=0x%04x host=0x%02x seq=0x%02x flags=0x%08x\n",
246 hdr->type, hdr->host, hdr->seq, hdr->flags);
250 * ti_sci_rx_callback() - mailbox client callback for receive messages
251 * @cl: client pointer
252 * @m: mailbox message
254 * Processes one received message to appropriate transfer information and
255 * signals completion of the transfer.
257 * NOTE: This function will be invoked in IRQ context, hence should be
258 * as optimal as possible.
260 static void ti_sci_rx_callback(struct mbox_client *cl, void *m)
262 struct ti_sci_info *info = cl_to_ti_sci_info(cl);
263 struct device *dev = info->dev;
264 struct ti_sci_xfers_info *minfo = &info->minfo;
265 struct ti_msgmgr_message *mbox_msg = m;
266 struct ti_sci_msg_hdr *hdr = (struct ti_sci_msg_hdr *)mbox_msg->buf;
267 struct ti_sci_xfer *xfer;
273 * Are we even expecting this?
274 * NOTE: barriers were implicit in locks used for modifying the bitmap
276 if (!test_bit(xfer_id, minfo->xfer_alloc_table)) {
277 dev_err(dev, "Message for %d is not expected!\n", xfer_id);
281 xfer = &minfo->xfer_block[xfer_id];
283 /* Is the message of valid length? */
284 if (mbox_msg->len > info->desc->max_msg_size) {
285 dev_err(dev, "Unable to handle %zu xfer(max %d)\n",
286 mbox_msg->len, info->desc->max_msg_size);
287 ti_sci_dump_header_dbg(dev, hdr);
290 if (mbox_msg->len < xfer->rx_len) {
291 dev_err(dev, "Recv xfer %zu < expected %d length\n",
292 mbox_msg->len, xfer->rx_len);
293 ti_sci_dump_header_dbg(dev, hdr);
297 ti_sci_dump_header_dbg(dev, hdr);
298 /* Take a copy to the rx buffer.. */
299 memcpy(xfer->xfer_buf, mbox_msg->buf, xfer->rx_len);
300 complete(&xfer->done);
304 * ti_sci_get_one_xfer() - Allocate one message
305 * @info: Pointer to SCI entity information
306 * @msg_type: Message type
307 * @msg_flags: Flag to set for the message
308 * @tx_message_size: transmit message size
309 * @rx_message_size: receive message size
311 * Helper function which is used by various command functions that are
312 * exposed to clients of this driver for allocating a message traffic event.
314 * This function can sleep depending on pending requests already in the system
315 * for the SCI entity. Further, this also holds a spinlock to maintain integrity
316 * of internal data structures.
318 * Return: 0 if all went fine, else corresponding error.
320 static struct ti_sci_xfer *ti_sci_get_one_xfer(struct ti_sci_info *info,
321 u16 msg_type, u32 msg_flags,
322 size_t tx_message_size,
323 size_t rx_message_size)
325 struct ti_sci_xfers_info *minfo = &info->minfo;
326 struct ti_sci_xfer *xfer;
327 struct ti_sci_msg_hdr *hdr;
329 unsigned long bit_pos;
334 /* Ensure we have sane transfer sizes */
335 if (rx_message_size > info->desc->max_msg_size ||
336 tx_message_size > info->desc->max_msg_size ||
337 rx_message_size < sizeof(*hdr) || tx_message_size < sizeof(*hdr))
338 return ERR_PTR(-ERANGE);
341 * Ensure we have only controlled number of pending messages.
342 * Ideally, we might just have to wait a single message, be
343 * conservative and wait 5 times that..
345 timeout = msecs_to_jiffies(info->desc->max_rx_timeout_ms) * 5;
346 ret = down_timeout(&minfo->sem_xfer_count, timeout);
350 /* Keep the locked section as small as possible */
351 spin_lock_irqsave(&minfo->xfer_lock, flags);
352 bit_pos = find_first_zero_bit(minfo->xfer_alloc_table,
353 info->desc->max_msgs);
354 set_bit(bit_pos, minfo->xfer_alloc_table);
355 spin_unlock_irqrestore(&minfo->xfer_lock, flags);
358 * We already ensured in probe that we can have max messages that can
359 * fit in hdr.seq - NOTE: this improves access latencies
360 * to predictable O(1) access, BUT, it opens us to risk if
361 * remote misbehaves with corrupted message sequence responses.
362 * If that happens, we are going to be messed up anyways..
364 xfer_id = (u8)bit_pos;
366 xfer = &minfo->xfer_block[xfer_id];
368 hdr = (struct ti_sci_msg_hdr *)xfer->tx_message.buf;
369 xfer->tx_message.len = tx_message_size;
370 xfer->rx_len = (u8)rx_message_size;
372 reinit_completion(&xfer->done);
375 hdr->type = msg_type;
376 hdr->host = info->host_id;
377 hdr->flags = msg_flags;
383 * ti_sci_put_one_xfer() - Release a message
384 * @minfo: transfer info pointer
385 * @xfer: message that was reserved by ti_sci_get_one_xfer
387 * This holds a spinlock to maintain integrity of internal data structures.
389 static void ti_sci_put_one_xfer(struct ti_sci_xfers_info *minfo,
390 struct ti_sci_xfer *xfer)
393 struct ti_sci_msg_hdr *hdr;
396 hdr = (struct ti_sci_msg_hdr *)xfer->tx_message.buf;
400 * Keep the locked section as small as possible
401 * NOTE: we might escape with smp_mb and no lock here..
402 * but just be conservative and symmetric.
404 spin_lock_irqsave(&minfo->xfer_lock, flags);
405 clear_bit(xfer_id, minfo->xfer_alloc_table);
406 spin_unlock_irqrestore(&minfo->xfer_lock, flags);
408 /* Increment the count for the next user to get through */
409 up(&minfo->sem_xfer_count);
413 * ti_sci_do_xfer() - Do one transfer
414 * @info: Pointer to SCI entity information
415 * @xfer: Transfer to initiate and wait for response
417 * Return: -ETIMEDOUT in case of no response, if transmit error,
418 * return corresponding error, else if all goes well,
421 static inline int ti_sci_do_xfer(struct ti_sci_info *info,
422 struct ti_sci_xfer *xfer)
426 struct device *dev = info->dev;
428 ret = mbox_send_message(info->chan_tx, &xfer->tx_message);
434 /* And we wait for the response. */
435 timeout = msecs_to_jiffies(info->desc->max_rx_timeout_ms);
436 if (!wait_for_completion_timeout(&xfer->done, timeout)) {
437 dev_err(dev, "Mbox timedout in resp(caller: %pS)\n",
442 * NOTE: we might prefer not to need the mailbox ticker to manage the
443 * transfer queueing since the protocol layer queues things by itself.
444 * Unfortunately, we have to kick the mailbox framework after we have
445 * received our message.
447 mbox_client_txdone(info->chan_tx, ret);
453 * ti_sci_cmd_get_revision() - command to get the revision of the SCI entity
454 * @info: Pointer to SCI entity information
456 * Updates the SCI information in the internal data structure.
458 * Return: 0 if all went fine, else return appropriate error.
460 static int ti_sci_cmd_get_revision(struct ti_sci_info *info)
462 struct device *dev = info->dev;
463 struct ti_sci_handle *handle = &info->handle;
464 struct ti_sci_version_info *ver = &handle->version;
465 struct ti_sci_msg_resp_version *rev_info;
466 struct ti_sci_xfer *xfer;
469 /* No need to setup flags since it is expected to respond */
470 xfer = ti_sci_get_one_xfer(info, TI_SCI_MSG_VERSION,
471 0x0, sizeof(struct ti_sci_msg_hdr),
475 dev_err(dev, "Message alloc failed(%d)\n", ret);
479 rev_info = (struct ti_sci_msg_resp_version *)xfer->xfer_buf;
481 ret = ti_sci_do_xfer(info, xfer);
483 dev_err(dev, "Mbox send fail %d\n", ret);
487 ver->abi_major = rev_info->abi_major;
488 ver->abi_minor = rev_info->abi_minor;
489 ver->firmware_revision = rev_info->firmware_revision;
490 strncpy(ver->firmware_description, rev_info->firmware_description,
491 sizeof(ver->firmware_description));
494 ti_sci_put_one_xfer(&info->minfo, xfer);
499 * ti_sci_is_response_ack() - Generic ACK/NACK message checkup
500 * @r: pointer to response buffer
502 * Return: true if the response was an ACK, else returns false.
504 static inline bool ti_sci_is_response_ack(void *r)
506 struct ti_sci_msg_hdr *hdr = r;
508 return hdr->flags & TI_SCI_FLAG_RESP_GENERIC_ACK ? true : false;
512 * ti_sci_set_device_state() - Set device state helper
513 * @handle: pointer to TI SCI handle
514 * @id: Device identifier
515 * @flags: flags to setup for the device
516 * @state: State to move the device to
518 * Return: 0 if all went well, else returns appropriate error value.
520 static int ti_sci_set_device_state(const struct ti_sci_handle *handle,
521 u32 id, u32 flags, u8 state)
523 struct ti_sci_info *info;
524 struct ti_sci_msg_req_set_device_state *req;
525 struct ti_sci_msg_hdr *resp;
526 struct ti_sci_xfer *xfer;
531 return PTR_ERR(handle);
535 info = handle_to_ti_sci_info(handle);
538 xfer = ti_sci_get_one_xfer(info, TI_SCI_MSG_SET_DEVICE_STATE,
539 flags | TI_SCI_FLAG_REQ_ACK_ON_PROCESSED,
540 sizeof(*req), sizeof(*resp));
543 dev_err(dev, "Message alloc failed(%d)\n", ret);
546 req = (struct ti_sci_msg_req_set_device_state *)xfer->xfer_buf;
550 ret = ti_sci_do_xfer(info, xfer);
552 dev_err(dev, "Mbox send fail %d\n", ret);
556 resp = (struct ti_sci_msg_hdr *)xfer->xfer_buf;
558 ret = ti_sci_is_response_ack(resp) ? 0 : -ENODEV;
561 ti_sci_put_one_xfer(&info->minfo, xfer);
567 * ti_sci_get_device_state() - Get device state helper
568 * @handle: Handle to the device
569 * @id: Device Identifier
570 * @clcnt: Pointer to Context Loss Count
571 * @resets: pointer to resets
572 * @p_state: pointer to p_state
573 * @c_state: pointer to c_state
575 * Return: 0 if all went fine, else return appropriate error.
577 static int ti_sci_get_device_state(const struct ti_sci_handle *handle,
578 u32 id, u32 *clcnt, u32 *resets,
579 u8 *p_state, u8 *c_state)
581 struct ti_sci_info *info;
582 struct ti_sci_msg_req_get_device_state *req;
583 struct ti_sci_msg_resp_get_device_state *resp;
584 struct ti_sci_xfer *xfer;
589 return PTR_ERR(handle);
593 if (!clcnt && !resets && !p_state && !c_state)
596 info = handle_to_ti_sci_info(handle);
599 /* Response is expected, so need of any flags */
600 xfer = ti_sci_get_one_xfer(info, TI_SCI_MSG_GET_DEVICE_STATE,
601 0, sizeof(*req), sizeof(*resp));
604 dev_err(dev, "Message alloc failed(%d)\n", ret);
607 req = (struct ti_sci_msg_req_get_device_state *)xfer->xfer_buf;
610 ret = ti_sci_do_xfer(info, xfer);
612 dev_err(dev, "Mbox send fail %d\n", ret);
616 resp = (struct ti_sci_msg_resp_get_device_state *)xfer->xfer_buf;
617 if (!ti_sci_is_response_ack(resp)) {
623 *clcnt = resp->context_loss_count;
625 *resets = resp->resets;
627 *p_state = resp->programmed_state;
629 *c_state = resp->current_state;
631 ti_sci_put_one_xfer(&info->minfo, xfer);
637 * ti_sci_cmd_get_device() - command to request for device managed by TISCI
638 * @handle: Pointer to TISCI handle as retrieved by *ti_sci_get_handle
639 * @id: Device Identifier
641 * Request for the device - NOTE: the client MUST maintain integrity of
642 * usage count by balancing get_device with put_device. No refcounting is
643 * managed by driver for that purpose.
645 * NOTE: The request is for exclusive access for the processor.
647 * Return: 0 if all went fine, else return appropriate error.
649 static int ti_sci_cmd_get_device(const struct ti_sci_handle *handle, u32 id)
651 return ti_sci_set_device_state(handle, id,
652 MSG_FLAG_DEVICE_EXCLUSIVE,
653 MSG_DEVICE_SW_STATE_ON);
657 * ti_sci_cmd_idle_device() - Command to idle a device managed by TISCI
658 * @handle: Pointer to TISCI handle as retrieved by *ti_sci_get_handle
659 * @id: Device Identifier
661 * Request for the device - NOTE: the client MUST maintain integrity of
662 * usage count by balancing get_device with put_device. No refcounting is
663 * managed by driver for that purpose.
665 * Return: 0 if all went fine, else return appropriate error.
667 static int ti_sci_cmd_idle_device(const struct ti_sci_handle *handle, u32 id)
669 return ti_sci_set_device_state(handle, id,
670 MSG_FLAG_DEVICE_EXCLUSIVE,
671 MSG_DEVICE_SW_STATE_RETENTION);
675 * ti_sci_cmd_put_device() - command to release a device managed by TISCI
676 * @handle: Pointer to TISCI handle as retrieved by *ti_sci_get_handle
677 * @id: Device Identifier
679 * Request for the device - NOTE: the client MUST maintain integrity of
680 * usage count by balancing get_device with put_device. No refcounting is
681 * managed by driver for that purpose.
683 * Return: 0 if all went fine, else return appropriate error.
685 static int ti_sci_cmd_put_device(const struct ti_sci_handle *handle, u32 id)
687 return ti_sci_set_device_state(handle, id,
688 0, MSG_DEVICE_SW_STATE_AUTO_OFF);
692 * ti_sci_cmd_dev_is_valid() - Is the device valid
693 * @handle: Pointer to TISCI handle as retrieved by *ti_sci_get_handle
694 * @id: Device Identifier
696 * Return: 0 if all went fine and the device ID is valid, else return
699 static int ti_sci_cmd_dev_is_valid(const struct ti_sci_handle *handle, u32 id)
703 /* check the device state which will also tell us if the ID is valid */
704 return ti_sci_get_device_state(handle, id, NULL, NULL, NULL, &unused);
708 * ti_sci_cmd_dev_get_clcnt() - Get context loss counter
709 * @handle: Pointer to TISCI handle
710 * @id: Device Identifier
711 * @count: Pointer to Context Loss counter to populate
713 * Return: 0 if all went fine, else return appropriate error.
715 static int ti_sci_cmd_dev_get_clcnt(const struct ti_sci_handle *handle, u32 id,
718 return ti_sci_get_device_state(handle, id, count, NULL, NULL, NULL);
722 * ti_sci_cmd_dev_is_idle() - Check if the device is requested to be idle
723 * @handle: Pointer to TISCI handle
724 * @id: Device Identifier
725 * @r_state: true if requested to be idle
727 * Return: 0 if all went fine, else return appropriate error.
729 static int ti_sci_cmd_dev_is_idle(const struct ti_sci_handle *handle, u32 id,
738 ret = ti_sci_get_device_state(handle, id, NULL, NULL, &state, NULL);
742 *r_state = (state == MSG_DEVICE_SW_STATE_RETENTION);
748 * ti_sci_cmd_dev_is_stop() - Check if the device is requested to be stopped
749 * @handle: Pointer to TISCI handle
750 * @id: Device Identifier
751 * @r_state: true if requested to be stopped
752 * @curr_state: true if currently stopped.
754 * Return: 0 if all went fine, else return appropriate error.
756 static int ti_sci_cmd_dev_is_stop(const struct ti_sci_handle *handle, u32 id,
757 bool *r_state, bool *curr_state)
762 if (!r_state && !curr_state)
766 ti_sci_get_device_state(handle, id, NULL, NULL, &p_state, &c_state);
771 *r_state = (p_state == MSG_DEVICE_SW_STATE_AUTO_OFF);
773 *curr_state = (c_state == MSG_DEVICE_HW_STATE_OFF);
779 * ti_sci_cmd_dev_is_on() - Check if the device is requested to be ON
780 * @handle: Pointer to TISCI handle
781 * @id: Device Identifier
782 * @r_state: true if requested to be ON
783 * @curr_state: true if currently ON and active
785 * Return: 0 if all went fine, else return appropriate error.
787 static int ti_sci_cmd_dev_is_on(const struct ti_sci_handle *handle, u32 id,
788 bool *r_state, bool *curr_state)
793 if (!r_state && !curr_state)
797 ti_sci_get_device_state(handle, id, NULL, NULL, &p_state, &c_state);
802 *r_state = (p_state == MSG_DEVICE_SW_STATE_ON);
804 *curr_state = (c_state == MSG_DEVICE_HW_STATE_ON);
810 * ti_sci_cmd_dev_is_trans() - Check if the device is currently transitioning
811 * @handle: Pointer to TISCI handle
812 * @id: Device Identifier
813 * @curr_state: true if currently transitioning.
815 * Return: 0 if all went fine, else return appropriate error.
817 static int ti_sci_cmd_dev_is_trans(const struct ti_sci_handle *handle, u32 id,
826 ret = ti_sci_get_device_state(handle, id, NULL, NULL, NULL, &state);
830 *curr_state = (state == MSG_DEVICE_HW_STATE_TRANS);
836 * ti_sci_cmd_set_device_resets() - command to set resets for device managed
838 * @handle: Pointer to TISCI handle as retrieved by *ti_sci_get_handle
839 * @id: Device Identifier
840 * @reset_state: Device specific reset bit field
842 * Return: 0 if all went fine, else return appropriate error.
844 static int ti_sci_cmd_set_device_resets(const struct ti_sci_handle *handle,
845 u32 id, u32 reset_state)
847 struct ti_sci_info *info;
848 struct ti_sci_msg_req_set_device_resets *req;
849 struct ti_sci_msg_hdr *resp;
850 struct ti_sci_xfer *xfer;
855 return PTR_ERR(handle);
859 info = handle_to_ti_sci_info(handle);
862 xfer = ti_sci_get_one_xfer(info, TI_SCI_MSG_SET_DEVICE_RESETS,
863 TI_SCI_FLAG_REQ_ACK_ON_PROCESSED,
864 sizeof(*req), sizeof(*resp));
867 dev_err(dev, "Message alloc failed(%d)\n", ret);
870 req = (struct ti_sci_msg_req_set_device_resets *)xfer->xfer_buf;
872 req->resets = reset_state;
874 ret = ti_sci_do_xfer(info, xfer);
876 dev_err(dev, "Mbox send fail %d\n", ret);
880 resp = (struct ti_sci_msg_hdr *)xfer->xfer_buf;
882 ret = ti_sci_is_response_ack(resp) ? 0 : -ENODEV;
885 ti_sci_put_one_xfer(&info->minfo, xfer);
891 * ti_sci_cmd_get_device_resets() - Get reset state for device managed
893 * @handle: Pointer to TISCI handle
894 * @id: Device Identifier
895 * @reset_state: Pointer to reset state to populate
897 * Return: 0 if all went fine, else return appropriate error.
899 static int ti_sci_cmd_get_device_resets(const struct ti_sci_handle *handle,
900 u32 id, u32 *reset_state)
902 return ti_sci_get_device_state(handle, id, NULL, reset_state, NULL,
907 * ti_sci_set_clock_state() - Set clock state helper
908 * @handle: pointer to TI SCI handle
909 * @dev_id: Device identifier this request is for
910 * @clk_id: Clock identifier for the device for this request.
911 * Each device has it's own set of clock inputs. This indexes
912 * which clock input to modify.
913 * @flags: Header flags as needed
914 * @state: State to request for the clock.
916 * Return: 0 if all went well, else returns appropriate error value.
918 static int ti_sci_set_clock_state(const struct ti_sci_handle *handle,
919 u32 dev_id, u32 clk_id,
922 struct ti_sci_info *info;
923 struct ti_sci_msg_req_set_clock_state *req;
924 struct ti_sci_msg_hdr *resp;
925 struct ti_sci_xfer *xfer;
930 return PTR_ERR(handle);
934 info = handle_to_ti_sci_info(handle);
937 xfer = ti_sci_get_one_xfer(info, TI_SCI_MSG_SET_CLOCK_STATE,
938 flags | TI_SCI_FLAG_REQ_ACK_ON_PROCESSED,
939 sizeof(*req), sizeof(*resp));
942 dev_err(dev, "Message alloc failed(%d)\n", ret);
945 req = (struct ti_sci_msg_req_set_clock_state *)xfer->xfer_buf;
946 req->dev_id = dev_id;
948 req->clk_id = clk_id;
951 req->clk_id_32 = clk_id;
953 req->request_state = state;
955 ret = ti_sci_do_xfer(info, xfer);
957 dev_err(dev, "Mbox send fail %d\n", ret);
961 resp = (struct ti_sci_msg_hdr *)xfer->xfer_buf;
963 ret = ti_sci_is_response_ack(resp) ? 0 : -ENODEV;
966 ti_sci_put_one_xfer(&info->minfo, xfer);
972 * ti_sci_cmd_get_clock_state() - Get clock state helper
973 * @handle: pointer to TI SCI handle
974 * @dev_id: Device identifier this request is for
975 * @clk_id: Clock identifier for the device for this request.
976 * Each device has it's own set of clock inputs. This indexes
977 * which clock input to modify.
978 * @programmed_state: State requested for clock to move to
979 * @current_state: State that the clock is currently in
981 * Return: 0 if all went well, else returns appropriate error value.
983 static int ti_sci_cmd_get_clock_state(const struct ti_sci_handle *handle,
984 u32 dev_id, u32 clk_id,
985 u8 *programmed_state, u8 *current_state)
987 struct ti_sci_info *info;
988 struct ti_sci_msg_req_get_clock_state *req;
989 struct ti_sci_msg_resp_get_clock_state *resp;
990 struct ti_sci_xfer *xfer;
995 return PTR_ERR(handle);
999 if (!programmed_state && !current_state)
1002 info = handle_to_ti_sci_info(handle);
1005 xfer = ti_sci_get_one_xfer(info, TI_SCI_MSG_GET_CLOCK_STATE,
1006 TI_SCI_FLAG_REQ_ACK_ON_PROCESSED,
1007 sizeof(*req), sizeof(*resp));
1009 ret = PTR_ERR(xfer);
1010 dev_err(dev, "Message alloc failed(%d)\n", ret);
1013 req = (struct ti_sci_msg_req_get_clock_state *)xfer->xfer_buf;
1014 req->dev_id = dev_id;
1016 req->clk_id = clk_id;
1019 req->clk_id_32 = clk_id;
1022 ret = ti_sci_do_xfer(info, xfer);
1024 dev_err(dev, "Mbox send fail %d\n", ret);
1028 resp = (struct ti_sci_msg_resp_get_clock_state *)xfer->xfer_buf;
1030 if (!ti_sci_is_response_ack(resp)) {
1035 if (programmed_state)
1036 *programmed_state = resp->programmed_state;
1038 *current_state = resp->current_state;
1041 ti_sci_put_one_xfer(&info->minfo, xfer);
1047 * ti_sci_cmd_get_clock() - Get control of a clock from TI SCI
1048 * @handle: pointer to TI SCI handle
1049 * @dev_id: Device identifier this request is for
1050 * @clk_id: Clock identifier for the device for this request.
1051 * Each device has it's own set of clock inputs. This indexes
1052 * which clock input to modify.
1053 * @needs_ssc: 'true' if Spread Spectrum clock is desired, else 'false'
1054 * @can_change_freq: 'true' if frequency change is desired, else 'false'
1055 * @enable_input_term: 'true' if input termination is desired, else 'false'
1057 * Return: 0 if all went well, else returns appropriate error value.
1059 static int ti_sci_cmd_get_clock(const struct ti_sci_handle *handle, u32 dev_id,
1060 u32 clk_id, bool needs_ssc,
1061 bool can_change_freq, bool enable_input_term)
1065 flags |= needs_ssc ? MSG_FLAG_CLOCK_ALLOW_SSC : 0;
1066 flags |= can_change_freq ? MSG_FLAG_CLOCK_ALLOW_FREQ_CHANGE : 0;
1067 flags |= enable_input_term ? MSG_FLAG_CLOCK_INPUT_TERM : 0;
1069 return ti_sci_set_clock_state(handle, dev_id, clk_id, flags,
1070 MSG_CLOCK_SW_STATE_REQ);
1074 * ti_sci_cmd_idle_clock() - Idle a clock which is in our control
1075 * @handle: pointer to TI SCI handle
1076 * @dev_id: Device identifier this request is for
1077 * @clk_id: Clock identifier for the device for this request.
1078 * Each device has it's own set of clock inputs. This indexes
1079 * which clock input to modify.
1081 * NOTE: This clock must have been requested by get_clock previously.
1083 * Return: 0 if all went well, else returns appropriate error value.
1085 static int ti_sci_cmd_idle_clock(const struct ti_sci_handle *handle,
1086 u32 dev_id, u32 clk_id)
1088 return ti_sci_set_clock_state(handle, dev_id, clk_id, 0,
1089 MSG_CLOCK_SW_STATE_UNREQ);
1093 * ti_sci_cmd_put_clock() - Release a clock from our control back to TISCI
1094 * @handle: pointer to TI SCI handle
1095 * @dev_id: Device identifier this request is for
1096 * @clk_id: Clock identifier for the device for this request.
1097 * Each device has it's own set of clock inputs. This indexes
1098 * which clock input to modify.
1100 * NOTE: This clock must have been requested by get_clock previously.
1102 * Return: 0 if all went well, else returns appropriate error value.
1104 static int ti_sci_cmd_put_clock(const struct ti_sci_handle *handle,
1105 u32 dev_id, u32 clk_id)
1107 return ti_sci_set_clock_state(handle, dev_id, clk_id, 0,
1108 MSG_CLOCK_SW_STATE_AUTO);
1112 * ti_sci_cmd_clk_is_auto() - Is the clock being auto managed
1113 * @handle: pointer to TI SCI handle
1114 * @dev_id: Device identifier this request is for
1115 * @clk_id: Clock identifier for the device for this request.
1116 * Each device has it's own set of clock inputs. This indexes
1117 * which clock input to modify.
1118 * @req_state: state indicating if the clock is auto managed
1120 * Return: 0 if all went well, else returns appropriate error value.
1122 static int ti_sci_cmd_clk_is_auto(const struct ti_sci_handle *handle,
1123 u32 dev_id, u32 clk_id, bool *req_state)
1131 ret = ti_sci_cmd_get_clock_state(handle, dev_id, clk_id, &state, NULL);
1135 *req_state = (state == MSG_CLOCK_SW_STATE_AUTO);
1140 * ti_sci_cmd_clk_is_on() - Is the clock ON
1141 * @handle: pointer to TI SCI handle
1142 * @dev_id: Device identifier this request is for
1143 * @clk_id: Clock identifier for the device for this request.
1144 * Each device has it's own set of clock inputs. This indexes
1145 * which clock input to modify.
1146 * @req_state: state indicating if the clock is managed by us and enabled
1147 * @curr_state: state indicating if the clock is ready for operation
1149 * Return: 0 if all went well, else returns appropriate error value.
1151 static int ti_sci_cmd_clk_is_on(const struct ti_sci_handle *handle, u32 dev_id,
1152 u32 clk_id, bool *req_state, bool *curr_state)
1154 u8 c_state = 0, r_state = 0;
1157 if (!req_state && !curr_state)
1160 ret = ti_sci_cmd_get_clock_state(handle, dev_id, clk_id,
1161 &r_state, &c_state);
1166 *req_state = (r_state == MSG_CLOCK_SW_STATE_REQ);
1168 *curr_state = (c_state == MSG_CLOCK_HW_STATE_READY);
1173 * ti_sci_cmd_clk_is_off() - Is the clock OFF
1174 * @handle: pointer to TI SCI handle
1175 * @dev_id: Device identifier this request is for
1176 * @clk_id: Clock identifier for the device for this request.
1177 * Each device has it's own set of clock inputs. This indexes
1178 * which clock input to modify.
1179 * @req_state: state indicating if the clock is managed by us and disabled
1180 * @curr_state: state indicating if the clock is NOT ready for operation
1182 * Return: 0 if all went well, else returns appropriate error value.
1184 static int ti_sci_cmd_clk_is_off(const struct ti_sci_handle *handle, u32 dev_id,
1185 u32 clk_id, bool *req_state, bool *curr_state)
1187 u8 c_state = 0, r_state = 0;
1190 if (!req_state && !curr_state)
1193 ret = ti_sci_cmd_get_clock_state(handle, dev_id, clk_id,
1194 &r_state, &c_state);
1199 *req_state = (r_state == MSG_CLOCK_SW_STATE_UNREQ);
1201 *curr_state = (c_state == MSG_CLOCK_HW_STATE_NOT_READY);
1206 * ti_sci_cmd_clk_set_parent() - Set the clock source of a specific device clock
1207 * @handle: pointer to TI SCI handle
1208 * @dev_id: Device identifier this request is for
1209 * @clk_id: Clock identifier for the device for this request.
1210 * Each device has it's own set of clock inputs. This indexes
1211 * which clock input to modify.
1212 * @parent_id: Parent clock identifier to set
1214 * Return: 0 if all went well, else returns appropriate error value.
1216 static int ti_sci_cmd_clk_set_parent(const struct ti_sci_handle *handle,
1217 u32 dev_id, u32 clk_id, u32 parent_id)
1219 struct ti_sci_info *info;
1220 struct ti_sci_msg_req_set_clock_parent *req;
1221 struct ti_sci_msg_hdr *resp;
1222 struct ti_sci_xfer *xfer;
1227 return PTR_ERR(handle);
1231 info = handle_to_ti_sci_info(handle);
1234 xfer = ti_sci_get_one_xfer(info, TI_SCI_MSG_SET_CLOCK_PARENT,
1235 TI_SCI_FLAG_REQ_ACK_ON_PROCESSED,
1236 sizeof(*req), sizeof(*resp));
1238 ret = PTR_ERR(xfer);
1239 dev_err(dev, "Message alloc failed(%d)\n", ret);
1242 req = (struct ti_sci_msg_req_set_clock_parent *)xfer->xfer_buf;
1243 req->dev_id = dev_id;
1245 req->clk_id = clk_id;
1248 req->clk_id_32 = clk_id;
1250 if (parent_id < 255) {
1251 req->parent_id = parent_id;
1253 req->parent_id = 255;
1254 req->parent_id_32 = parent_id;
1257 ret = ti_sci_do_xfer(info, xfer);
1259 dev_err(dev, "Mbox send fail %d\n", ret);
1263 resp = (struct ti_sci_msg_hdr *)xfer->xfer_buf;
1265 ret = ti_sci_is_response_ack(resp) ? 0 : -ENODEV;
1268 ti_sci_put_one_xfer(&info->minfo, xfer);
1274 * ti_sci_cmd_clk_get_parent() - Get current parent clock source
1275 * @handle: pointer to TI SCI handle
1276 * @dev_id: Device identifier this request is for
1277 * @clk_id: Clock identifier for the device for this request.
1278 * Each device has it's own set of clock inputs. This indexes
1279 * which clock input to modify.
1280 * @parent_id: Current clock parent
1282 * Return: 0 if all went well, else returns appropriate error value.
1284 static int ti_sci_cmd_clk_get_parent(const struct ti_sci_handle *handle,
1285 u32 dev_id, u32 clk_id, u32 *parent_id)
1287 struct ti_sci_info *info;
1288 struct ti_sci_msg_req_get_clock_parent *req;
1289 struct ti_sci_msg_resp_get_clock_parent *resp;
1290 struct ti_sci_xfer *xfer;
1295 return PTR_ERR(handle);
1296 if (!handle || !parent_id)
1299 info = handle_to_ti_sci_info(handle);
1302 xfer = ti_sci_get_one_xfer(info, TI_SCI_MSG_GET_CLOCK_PARENT,
1303 TI_SCI_FLAG_REQ_ACK_ON_PROCESSED,
1304 sizeof(*req), sizeof(*resp));
1306 ret = PTR_ERR(xfer);
1307 dev_err(dev, "Message alloc failed(%d)\n", ret);
1310 req = (struct ti_sci_msg_req_get_clock_parent *)xfer->xfer_buf;
1311 req->dev_id = dev_id;
1313 req->clk_id = clk_id;
1316 req->clk_id_32 = clk_id;
1319 ret = ti_sci_do_xfer(info, xfer);
1321 dev_err(dev, "Mbox send fail %d\n", ret);
1325 resp = (struct ti_sci_msg_resp_get_clock_parent *)xfer->xfer_buf;
1327 if (!ti_sci_is_response_ack(resp)) {
1330 if (resp->parent_id < 255)
1331 *parent_id = resp->parent_id;
1333 *parent_id = resp->parent_id_32;
1337 ti_sci_put_one_xfer(&info->minfo, xfer);
1343 * ti_sci_cmd_clk_get_num_parents() - Get num parents of the current clk source
1344 * @handle: pointer to TI SCI handle
1345 * @dev_id: Device identifier this request is for
1346 * @clk_id: Clock identifier for the device for this request.
1347 * Each device has it's own set of clock inputs. This indexes
1348 * which clock input to modify.
1349 * @num_parents: Returns he number of parents to the current clock.
1351 * Return: 0 if all went well, else returns appropriate error value.
1353 static int ti_sci_cmd_clk_get_num_parents(const struct ti_sci_handle *handle,
1354 u32 dev_id, u32 clk_id,
1357 struct ti_sci_info *info;
1358 struct ti_sci_msg_req_get_clock_num_parents *req;
1359 struct ti_sci_msg_resp_get_clock_num_parents *resp;
1360 struct ti_sci_xfer *xfer;
1365 return PTR_ERR(handle);
1366 if (!handle || !num_parents)
1369 info = handle_to_ti_sci_info(handle);
1372 xfer = ti_sci_get_one_xfer(info, TI_SCI_MSG_GET_NUM_CLOCK_PARENTS,
1373 TI_SCI_FLAG_REQ_ACK_ON_PROCESSED,
1374 sizeof(*req), sizeof(*resp));
1376 ret = PTR_ERR(xfer);
1377 dev_err(dev, "Message alloc failed(%d)\n", ret);
1380 req = (struct ti_sci_msg_req_get_clock_num_parents *)xfer->xfer_buf;
1381 req->dev_id = dev_id;
1383 req->clk_id = clk_id;
1386 req->clk_id_32 = clk_id;
1389 ret = ti_sci_do_xfer(info, xfer);
1391 dev_err(dev, "Mbox send fail %d\n", ret);
1395 resp = (struct ti_sci_msg_resp_get_clock_num_parents *)xfer->xfer_buf;
1397 if (!ti_sci_is_response_ack(resp)) {
1400 if (resp->num_parents < 255)
1401 *num_parents = resp->num_parents;
1403 *num_parents = resp->num_parents_32;
1407 ti_sci_put_one_xfer(&info->minfo, xfer);
1413 * ti_sci_cmd_clk_get_match_freq() - Find a good match for frequency
1414 * @handle: pointer to TI SCI handle
1415 * @dev_id: Device identifier this request is for
1416 * @clk_id: Clock identifier for the device for this request.
1417 * Each device has it's own set of clock inputs. This indexes
1418 * which clock input to modify.
1419 * @min_freq: The minimum allowable frequency in Hz. This is the minimum
1420 * allowable programmed frequency and does not account for clock
1421 * tolerances and jitter.
1422 * @target_freq: The target clock frequency in Hz. A frequency will be
1423 * processed as close to this target frequency as possible.
1424 * @max_freq: The maximum allowable frequency in Hz. This is the maximum
1425 * allowable programmed frequency and does not account for clock
1426 * tolerances and jitter.
1427 * @match_freq: Frequency match in Hz response.
1429 * Return: 0 if all went well, else returns appropriate error value.
1431 static int ti_sci_cmd_clk_get_match_freq(const struct ti_sci_handle *handle,
1432 u32 dev_id, u32 clk_id, u64 min_freq,
1433 u64 target_freq, u64 max_freq,
1436 struct ti_sci_info *info;
1437 struct ti_sci_msg_req_query_clock_freq *req;
1438 struct ti_sci_msg_resp_query_clock_freq *resp;
1439 struct ti_sci_xfer *xfer;
1444 return PTR_ERR(handle);
1445 if (!handle || !match_freq)
1448 info = handle_to_ti_sci_info(handle);
1451 xfer = ti_sci_get_one_xfer(info, TI_SCI_MSG_QUERY_CLOCK_FREQ,
1452 TI_SCI_FLAG_REQ_ACK_ON_PROCESSED,
1453 sizeof(*req), sizeof(*resp));
1455 ret = PTR_ERR(xfer);
1456 dev_err(dev, "Message alloc failed(%d)\n", ret);
1459 req = (struct ti_sci_msg_req_query_clock_freq *)xfer->xfer_buf;
1460 req->dev_id = dev_id;
1462 req->clk_id = clk_id;
1465 req->clk_id_32 = clk_id;
1467 req->min_freq_hz = min_freq;
1468 req->target_freq_hz = target_freq;
1469 req->max_freq_hz = max_freq;
1471 ret = ti_sci_do_xfer(info, xfer);
1473 dev_err(dev, "Mbox send fail %d\n", ret);
1477 resp = (struct ti_sci_msg_resp_query_clock_freq *)xfer->xfer_buf;
1479 if (!ti_sci_is_response_ack(resp))
1482 *match_freq = resp->freq_hz;
1485 ti_sci_put_one_xfer(&info->minfo, xfer);
1491 * ti_sci_cmd_clk_set_freq() - Set a frequency for clock
1492 * @handle: pointer to TI SCI handle
1493 * @dev_id: Device identifier this request is for
1494 * @clk_id: Clock identifier for the device for this request.
1495 * Each device has it's own set of clock inputs. This indexes
1496 * which clock input to modify.
1497 * @min_freq: The minimum allowable frequency in Hz. This is the minimum
1498 * allowable programmed frequency and does not account for clock
1499 * tolerances and jitter.
1500 * @target_freq: The target clock frequency in Hz. A frequency will be
1501 * processed as close to this target frequency as possible.
1502 * @max_freq: The maximum allowable frequency in Hz. This is the maximum
1503 * allowable programmed frequency and does not account for clock
1504 * tolerances and jitter.
1506 * Return: 0 if all went well, else returns appropriate error value.
1508 static int ti_sci_cmd_clk_set_freq(const struct ti_sci_handle *handle,
1509 u32 dev_id, u32 clk_id, u64 min_freq,
1510 u64 target_freq, u64 max_freq)
1512 struct ti_sci_info *info;
1513 struct ti_sci_msg_req_set_clock_freq *req;
1514 struct ti_sci_msg_hdr *resp;
1515 struct ti_sci_xfer *xfer;
1520 return PTR_ERR(handle);
1524 info = handle_to_ti_sci_info(handle);
1527 xfer = ti_sci_get_one_xfer(info, TI_SCI_MSG_SET_CLOCK_FREQ,
1528 TI_SCI_FLAG_REQ_ACK_ON_PROCESSED,
1529 sizeof(*req), sizeof(*resp));
1531 ret = PTR_ERR(xfer);
1532 dev_err(dev, "Message alloc failed(%d)\n", ret);
1535 req = (struct ti_sci_msg_req_set_clock_freq *)xfer->xfer_buf;
1536 req->dev_id = dev_id;
1538 req->clk_id = clk_id;
1541 req->clk_id_32 = clk_id;
1543 req->min_freq_hz = min_freq;
1544 req->target_freq_hz = target_freq;
1545 req->max_freq_hz = max_freq;
1547 ret = ti_sci_do_xfer(info, xfer);
1549 dev_err(dev, "Mbox send fail %d\n", ret);
1553 resp = (struct ti_sci_msg_hdr *)xfer->xfer_buf;
1555 ret = ti_sci_is_response_ack(resp) ? 0 : -ENODEV;
1558 ti_sci_put_one_xfer(&info->minfo, xfer);
1564 * ti_sci_cmd_clk_get_freq() - Get current frequency
1565 * @handle: pointer to TI SCI handle
1566 * @dev_id: Device identifier this request is for
1567 * @clk_id: Clock identifier for the device for this request.
1568 * Each device has it's own set of clock inputs. This indexes
1569 * which clock input to modify.
1570 * @freq: Currently frequency in Hz
1572 * Return: 0 if all went well, else returns appropriate error value.
1574 static int ti_sci_cmd_clk_get_freq(const struct ti_sci_handle *handle,
1575 u32 dev_id, u32 clk_id, u64 *freq)
1577 struct ti_sci_info *info;
1578 struct ti_sci_msg_req_get_clock_freq *req;
1579 struct ti_sci_msg_resp_get_clock_freq *resp;
1580 struct ti_sci_xfer *xfer;
1585 return PTR_ERR(handle);
1586 if (!handle || !freq)
1589 info = handle_to_ti_sci_info(handle);
1592 xfer = ti_sci_get_one_xfer(info, TI_SCI_MSG_GET_CLOCK_FREQ,
1593 TI_SCI_FLAG_REQ_ACK_ON_PROCESSED,
1594 sizeof(*req), sizeof(*resp));
1596 ret = PTR_ERR(xfer);
1597 dev_err(dev, "Message alloc failed(%d)\n", ret);
1600 req = (struct ti_sci_msg_req_get_clock_freq *)xfer->xfer_buf;
1601 req->dev_id = dev_id;
1603 req->clk_id = clk_id;
1606 req->clk_id_32 = clk_id;
1609 ret = ti_sci_do_xfer(info, xfer);
1611 dev_err(dev, "Mbox send fail %d\n", ret);
1615 resp = (struct ti_sci_msg_resp_get_clock_freq *)xfer->xfer_buf;
1617 if (!ti_sci_is_response_ack(resp))
1620 *freq = resp->freq_hz;
1623 ti_sci_put_one_xfer(&info->minfo, xfer);
1628 static int ti_sci_cmd_core_reboot(const struct ti_sci_handle *handle)
1630 struct ti_sci_info *info;
1631 struct ti_sci_msg_req_reboot *req;
1632 struct ti_sci_msg_hdr *resp;
1633 struct ti_sci_xfer *xfer;
1638 return PTR_ERR(handle);
1642 info = handle_to_ti_sci_info(handle);
1645 xfer = ti_sci_get_one_xfer(info, TI_SCI_MSG_SYS_RESET,
1646 TI_SCI_FLAG_REQ_ACK_ON_PROCESSED,
1647 sizeof(*req), sizeof(*resp));
1649 ret = PTR_ERR(xfer);
1650 dev_err(dev, "Message alloc failed(%d)\n", ret);
1653 req = (struct ti_sci_msg_req_reboot *)xfer->xfer_buf;
1655 ret = ti_sci_do_xfer(info, xfer);
1657 dev_err(dev, "Mbox send fail %d\n", ret);
1661 resp = (struct ti_sci_msg_hdr *)xfer->xfer_buf;
1663 if (!ti_sci_is_response_ack(resp))
1669 ti_sci_put_one_xfer(&info->minfo, xfer);
1674 static int ti_sci_get_resource_type(struct ti_sci_info *info, u16 dev_id,
1677 struct ti_sci_rm_type_map *rm_type_map = info->desc->rm_type_map;
1681 /* If map is not provided then assume dev_id is used as type */
1687 for (i = 0; rm_type_map[i].dev_id; i++) {
1688 if (rm_type_map[i].dev_id == dev_id) {
1689 *type = rm_type_map[i].type;
1702 * ti_sci_get_resource_range - Helper to get a range of resources assigned
1703 * to a host. Resource is uniquely identified by
1705 * @handle: Pointer to TISCI handle.
1706 * @dev_id: TISCI device ID.
1707 * @subtype: Resource assignment subtype that is being requested
1708 * from the given device.
1709 * @s_host: Host processor ID to which the resources are allocated
1710 * @range_start: Start index of the resource range
1711 * @range_num: Number of resources in the range
1713 * Return: 0 if all went fine, else return appropriate error.
1715 static int ti_sci_get_resource_range(const struct ti_sci_handle *handle,
1716 u32 dev_id, u8 subtype, u8 s_host,
1717 u16 *range_start, u16 *range_num)
1719 struct ti_sci_msg_resp_get_resource_range *resp;
1720 struct ti_sci_msg_req_get_resource_range *req;
1721 struct ti_sci_xfer *xfer;
1722 struct ti_sci_info *info;
1728 return PTR_ERR(handle);
1732 info = handle_to_ti_sci_info(handle);
1735 xfer = ti_sci_get_one_xfer(info, TI_SCI_MSG_GET_RESOURCE_RANGE,
1736 TI_SCI_FLAG_REQ_ACK_ON_PROCESSED,
1737 sizeof(*req), sizeof(*resp));
1739 ret = PTR_ERR(xfer);
1740 dev_err(dev, "Message alloc failed(%d)\n", ret);
1744 ret = ti_sci_get_resource_type(info, dev_id, &type);
1746 dev_err(dev, "rm type lookup failed for %u\n", dev_id);
1750 req = (struct ti_sci_msg_req_get_resource_range *)xfer->xfer_buf;
1751 req->secondary_host = s_host;
1752 req->type = type & MSG_RM_RESOURCE_TYPE_MASK;
1753 req->subtype = subtype & MSG_RM_RESOURCE_SUBTYPE_MASK;
1755 ret = ti_sci_do_xfer(info, xfer);
1757 dev_err(dev, "Mbox send fail %d\n", ret);
1761 resp = (struct ti_sci_msg_resp_get_resource_range *)xfer->xfer_buf;
1763 if (!ti_sci_is_response_ack(resp)) {
1765 } else if (!resp->range_start && !resp->range_num) {
1768 *range_start = resp->range_start;
1769 *range_num = resp->range_num;
1773 ti_sci_put_one_xfer(&info->minfo, xfer);
1779 * ti_sci_cmd_get_resource_range - Get a range of resources assigned to host
1780 * that is same as ti sci interface host.
1781 * @handle: Pointer to TISCI handle.
1782 * @dev_id: TISCI device ID.
1783 * @subtype: Resource assignment subtype that is being requested
1784 * from the given device.
1785 * @range_start: Start index of the resource range
1786 * @range_num: Number of resources in the range
1788 * Return: 0 if all went fine, else return appropriate error.
1790 static int ti_sci_cmd_get_resource_range(const struct ti_sci_handle *handle,
1791 u32 dev_id, u8 subtype,
1792 u16 *range_start, u16 *range_num)
1794 return ti_sci_get_resource_range(handle, dev_id, subtype,
1795 TI_SCI_IRQ_SECONDARY_HOST_INVALID,
1796 range_start, range_num);
1800 * ti_sci_cmd_get_resource_range_from_shost - Get a range of resources
1801 * assigned to a specified host.
1802 * @handle: Pointer to TISCI handle.
1803 * @dev_id: TISCI device ID.
1804 * @subtype: Resource assignment subtype that is being requested
1805 * from the given device.
1806 * @s_host: Host processor ID to which the resources are allocated
1807 * @range_start: Start index of the resource range
1808 * @range_num: Number of resources in the range
1810 * Return: 0 if all went fine, else return appropriate error.
1813 int ti_sci_cmd_get_resource_range_from_shost(const struct ti_sci_handle *handle,
1814 u32 dev_id, u8 subtype, u8 s_host,
1815 u16 *range_start, u16 *range_num)
1817 return ti_sci_get_resource_range(handle, dev_id, subtype, s_host,
1818 range_start, range_num);
1822 * ti_sci_manage_irq() - Helper api to configure/release the irq route between
1823 * the requested source and destination
1824 * @handle: Pointer to TISCI handle.
1825 * @valid_params: Bit fields defining the validity of certain params
1826 * @src_id: Device ID of the IRQ source
1827 * @src_index: IRQ source index within the source device
1828 * @dst_id: Device ID of the IRQ destination
1829 * @dst_host_irq: IRQ number of the destination device
1830 * @ia_id: Device ID of the IA, if the IRQ flows through this IA
1831 * @vint: Virtual interrupt to be used within the IA
1832 * @global_event: Global event number to be used for the requesting event
1833 * @vint_status_bit: Virtual interrupt status bit to be used for the event
1834 * @s_host: Secondary host ID to which the irq/event is being
1836 * @type: Request type irq set or release.
1838 * Return: 0 if all went fine, else return appropriate error.
1840 static int ti_sci_manage_irq(const struct ti_sci_handle *handle,
1841 u32 valid_params, u16 src_id, u16 src_index,
1842 u16 dst_id, u16 dst_host_irq, u16 ia_id, u16 vint,
1843 u16 global_event, u8 vint_status_bit, u8 s_host,
1846 struct ti_sci_msg_req_manage_irq *req;
1847 struct ti_sci_msg_hdr *resp;
1848 struct ti_sci_xfer *xfer;
1849 struct ti_sci_info *info;
1854 return PTR_ERR(handle);
1858 info = handle_to_ti_sci_info(handle);
1861 xfer = ti_sci_get_one_xfer(info, type, TI_SCI_FLAG_REQ_ACK_ON_PROCESSED,
1862 sizeof(*req), sizeof(*resp));
1864 ret = PTR_ERR(xfer);
1865 dev_err(dev, "Message alloc failed(%d)\n", ret);
1868 req = (struct ti_sci_msg_req_manage_irq *)xfer->xfer_buf;
1869 req->valid_params = valid_params;
1870 req->src_id = src_id;
1871 req->src_index = src_index;
1872 req->dst_id = dst_id;
1873 req->dst_host_irq = dst_host_irq;
1876 req->global_event = global_event;
1877 req->vint_status_bit = vint_status_bit;
1878 req->secondary_host = s_host;
1880 ret = ti_sci_do_xfer(info, xfer);
1882 dev_err(dev, "Mbox send fail %d\n", ret);
1886 resp = (struct ti_sci_msg_hdr *)xfer->xfer_buf;
1888 ret = ti_sci_is_response_ack(resp) ? 0 : -ENODEV;
1891 ti_sci_put_one_xfer(&info->minfo, xfer);
1897 * ti_sci_set_irq() - Helper api to configure the irq route between the
1898 * requested source and destination
1899 * @handle: Pointer to TISCI handle.
1900 * @valid_params: Bit fields defining the validity of certain params
1901 * @src_id: Device ID of the IRQ source
1902 * @src_index: IRQ source index within the source device
1903 * @dst_id: Device ID of the IRQ destination
1904 * @dst_host_irq: IRQ number of the destination device
1905 * @ia_id: Device ID of the IA, if the IRQ flows through this IA
1906 * @vint: Virtual interrupt to be used within the IA
1907 * @global_event: Global event number to be used for the requesting event
1908 * @vint_status_bit: Virtual interrupt status bit to be used for the event
1909 * @s_host: Secondary host ID to which the irq/event is being
1912 * Return: 0 if all went fine, else return appropriate error.
1914 static int ti_sci_set_irq(const struct ti_sci_handle *handle, u32 valid_params,
1915 u16 src_id, u16 src_index, u16 dst_id,
1916 u16 dst_host_irq, u16 ia_id, u16 vint,
1917 u16 global_event, u8 vint_status_bit, u8 s_host)
1919 pr_debug("%s: IRQ set with valid_params = 0x%x from src = %d, index = %d, to dst = %d, irq = %d,via ia_id = %d, vint = %d, global event = %d,status_bit = %d\n",
1920 __func__, valid_params, src_id, src_index,
1921 dst_id, dst_host_irq, ia_id, vint, global_event,
1924 return ti_sci_manage_irq(handle, valid_params, src_id, src_index,
1925 dst_id, dst_host_irq, ia_id, vint,
1926 global_event, vint_status_bit, s_host,
1927 TI_SCI_MSG_SET_IRQ);
1931 * ti_sci_free_irq() - Helper api to free the irq route between the
1932 * requested source and destination
1933 * @handle: Pointer to TISCI handle.
1934 * @valid_params: Bit fields defining the validity of certain params
1935 * @src_id: Device ID of the IRQ source
1936 * @src_index: IRQ source index within the source device
1937 * @dst_id: Device ID of the IRQ destination
1938 * @dst_host_irq: IRQ number of the destination device
1939 * @ia_id: Device ID of the IA, if the IRQ flows through this IA
1940 * @vint: Virtual interrupt to be used within the IA
1941 * @global_event: Global event number to be used for the requesting event
1942 * @vint_status_bit: Virtual interrupt status bit to be used for the event
1943 * @s_host: Secondary host ID to which the irq/event is being
1946 * Return: 0 if all went fine, else return appropriate error.
1948 static int ti_sci_free_irq(const struct ti_sci_handle *handle, u32 valid_params,
1949 u16 src_id, u16 src_index, u16 dst_id,
1950 u16 dst_host_irq, u16 ia_id, u16 vint,
1951 u16 global_event, u8 vint_status_bit, u8 s_host)
1953 pr_debug("%s: IRQ release with valid_params = 0x%x from src = %d, index = %d, to dst = %d, irq = %d,via ia_id = %d, vint = %d, global event = %d,status_bit = %d\n",
1954 __func__, valid_params, src_id, src_index,
1955 dst_id, dst_host_irq, ia_id, vint, global_event,
1958 return ti_sci_manage_irq(handle, valid_params, src_id, src_index,
1959 dst_id, dst_host_irq, ia_id, vint,
1960 global_event, vint_status_bit, s_host,
1961 TI_SCI_MSG_FREE_IRQ);
1965 * ti_sci_cmd_set_irq() - Configure a host irq route between the requested
1966 * source and destination.
1967 * @handle: Pointer to TISCI handle.
1968 * @src_id: Device ID of the IRQ source
1969 * @src_index: IRQ source index within the source device
1970 * @dst_id: Device ID of the IRQ destination
1971 * @dst_host_irq: IRQ number of the destination device
1972 * @vint_irq: Boolean specifying if this interrupt belongs to
1973 * Interrupt Aggregator.
1975 * Return: 0 if all went fine, else return appropriate error.
1977 static int ti_sci_cmd_set_irq(const struct ti_sci_handle *handle, u16 src_id,
1978 u16 src_index, u16 dst_id, u16 dst_host_irq)
1980 u32 valid_params = MSG_FLAG_DST_ID_VALID | MSG_FLAG_DST_HOST_IRQ_VALID;
1982 return ti_sci_set_irq(handle, valid_params, src_id, src_index, dst_id,
1983 dst_host_irq, 0, 0, 0, 0, 0);
1987 * ti_sci_cmd_set_event_map() - Configure an event based irq route between the
1988 * requested source and Interrupt Aggregator.
1989 * @handle: Pointer to TISCI handle.
1990 * @src_id: Device ID of the IRQ source
1991 * @src_index: IRQ source index within the source device
1992 * @ia_id: Device ID of the IA, if the IRQ flows through this IA
1993 * @vint: Virtual interrupt to be used within the IA
1994 * @global_event: Global event number to be used for the requesting event
1995 * @vint_status_bit: Virtual interrupt status bit to be used for the event
1997 * Return: 0 if all went fine, else return appropriate error.
1999 static int ti_sci_cmd_set_event_map(const struct ti_sci_handle *handle,
2000 u16 src_id, u16 src_index, u16 ia_id,
2001 u16 vint, u16 global_event,
2004 u32 valid_params = MSG_FLAG_IA_ID_VALID | MSG_FLAG_VINT_VALID |
2005 MSG_FLAG_GLB_EVNT_VALID |
2006 MSG_FLAG_VINT_STS_BIT_VALID;
2008 return ti_sci_set_irq(handle, valid_params, src_id, src_index, 0, 0,
2009 ia_id, vint, global_event, vint_status_bit, 0);
2013 * ti_sci_cmd_free_irq() - Free a host irq route between the between the
2014 * requested source and destination.
2015 * @handle: Pointer to TISCI handle.
2016 * @src_id: Device ID of the IRQ source
2017 * @src_index: IRQ source index within the source device
2018 * @dst_id: Device ID of the IRQ destination
2019 * @dst_host_irq: IRQ number of the destination device
2020 * @vint_irq: Boolean specifying if this interrupt belongs to
2021 * Interrupt Aggregator.
2023 * Return: 0 if all went fine, else return appropriate error.
2025 static int ti_sci_cmd_free_irq(const struct ti_sci_handle *handle, u16 src_id,
2026 u16 src_index, u16 dst_id, u16 dst_host_irq)
2028 u32 valid_params = MSG_FLAG_DST_ID_VALID | MSG_FLAG_DST_HOST_IRQ_VALID;
2030 return ti_sci_free_irq(handle, valid_params, src_id, src_index, dst_id,
2031 dst_host_irq, 0, 0, 0, 0, 0);
2035 * ti_sci_cmd_free_event_map() - Free an event map between the requested source
2036 * and Interrupt Aggregator.
2037 * @handle: Pointer to TISCI handle.
2038 * @src_id: Device ID of the IRQ source
2039 * @src_index: IRQ source index within the source device
2040 * @ia_id: Device ID of the IA, if the IRQ flows through this IA
2041 * @vint: Virtual interrupt to be used within the IA
2042 * @global_event: Global event number to be used for the requesting event
2043 * @vint_status_bit: Virtual interrupt status bit to be used for the event
2045 * Return: 0 if all went fine, else return appropriate error.
2047 static int ti_sci_cmd_free_event_map(const struct ti_sci_handle *handle,
2048 u16 src_id, u16 src_index, u16 ia_id,
2049 u16 vint, u16 global_event,
2052 u32 valid_params = MSG_FLAG_IA_ID_VALID |
2053 MSG_FLAG_VINT_VALID | MSG_FLAG_GLB_EVNT_VALID |
2054 MSG_FLAG_VINT_STS_BIT_VALID;
2056 return ti_sci_free_irq(handle, valid_params, src_id, src_index, 0, 0,
2057 ia_id, vint, global_event, vint_status_bit, 0);
2061 * ti_sci_setup_ops() - Setup the operations structures
2062 * @info: pointer to TISCI pointer
2064 static void ti_sci_setup_ops(struct ti_sci_info *info)
2066 struct ti_sci_ops *ops = &info->handle.ops;
2067 struct ti_sci_core_ops *core_ops = &ops->core_ops;
2068 struct ti_sci_dev_ops *dops = &ops->dev_ops;
2069 struct ti_sci_clk_ops *cops = &ops->clk_ops;
2070 struct ti_sci_rm_core_ops *rm_core_ops = &ops->rm_core_ops;
2071 struct ti_sci_rm_irq_ops *iops = &ops->rm_irq_ops;
2073 core_ops->reboot_device = ti_sci_cmd_core_reboot;
2075 dops->get_device = ti_sci_cmd_get_device;
2076 dops->idle_device = ti_sci_cmd_idle_device;
2077 dops->put_device = ti_sci_cmd_put_device;
2079 dops->is_valid = ti_sci_cmd_dev_is_valid;
2080 dops->get_context_loss_count = ti_sci_cmd_dev_get_clcnt;
2081 dops->is_idle = ti_sci_cmd_dev_is_idle;
2082 dops->is_stop = ti_sci_cmd_dev_is_stop;
2083 dops->is_on = ti_sci_cmd_dev_is_on;
2084 dops->is_transitioning = ti_sci_cmd_dev_is_trans;
2085 dops->set_device_resets = ti_sci_cmd_set_device_resets;
2086 dops->get_device_resets = ti_sci_cmd_get_device_resets;
2088 cops->get_clock = ti_sci_cmd_get_clock;
2089 cops->idle_clock = ti_sci_cmd_idle_clock;
2090 cops->put_clock = ti_sci_cmd_put_clock;
2091 cops->is_auto = ti_sci_cmd_clk_is_auto;
2092 cops->is_on = ti_sci_cmd_clk_is_on;
2093 cops->is_off = ti_sci_cmd_clk_is_off;
2095 cops->set_parent = ti_sci_cmd_clk_set_parent;
2096 cops->get_parent = ti_sci_cmd_clk_get_parent;
2097 cops->get_num_parents = ti_sci_cmd_clk_get_num_parents;
2099 cops->get_best_match_freq = ti_sci_cmd_clk_get_match_freq;
2100 cops->set_freq = ti_sci_cmd_clk_set_freq;
2101 cops->get_freq = ti_sci_cmd_clk_get_freq;
2103 rm_core_ops->get_range = ti_sci_cmd_get_resource_range;
2104 rm_core_ops->get_range_from_shost =
2105 ti_sci_cmd_get_resource_range_from_shost;
2107 iops->set_irq = ti_sci_cmd_set_irq;
2108 iops->set_event_map = ti_sci_cmd_set_event_map;
2109 iops->free_irq = ti_sci_cmd_free_irq;
2110 iops->free_event_map = ti_sci_cmd_free_event_map;
2114 * ti_sci_get_handle() - Get the TI SCI handle for a device
2115 * @dev: Pointer to device for which we want SCI handle
2117 * NOTE: The function does not track individual clients of the framework
2118 * and is expected to be maintained by caller of TI SCI protocol library.
2119 * ti_sci_put_handle must be balanced with successful ti_sci_get_handle
2120 * Return: pointer to handle if successful, else:
2121 * -EPROBE_DEFER if the instance is not ready
2122 * -ENODEV if the required node handler is missing
2123 * -EINVAL if invalid conditions are encountered.
2125 const struct ti_sci_handle *ti_sci_get_handle(struct device *dev)
2127 struct device_node *ti_sci_np;
2128 struct list_head *p;
2129 struct ti_sci_handle *handle = NULL;
2130 struct ti_sci_info *info;
2133 pr_err("I need a device pointer\n");
2134 return ERR_PTR(-EINVAL);
2136 ti_sci_np = of_get_parent(dev->of_node);
2138 dev_err(dev, "No OF information\n");
2139 return ERR_PTR(-EINVAL);
2142 mutex_lock(&ti_sci_list_mutex);
2143 list_for_each(p, &ti_sci_list) {
2144 info = list_entry(p, struct ti_sci_info, node);
2145 if (ti_sci_np == info->dev->of_node) {
2146 handle = &info->handle;
2151 mutex_unlock(&ti_sci_list_mutex);
2152 of_node_put(ti_sci_np);
2155 return ERR_PTR(-EPROBE_DEFER);
2159 EXPORT_SYMBOL_GPL(ti_sci_get_handle);
2162 * ti_sci_put_handle() - Release the handle acquired by ti_sci_get_handle
2163 * @handle: Handle acquired by ti_sci_get_handle
2165 * NOTE: The function does not track individual clients of the framework
2166 * and is expected to be maintained by caller of TI SCI protocol library.
2167 * ti_sci_put_handle must be balanced with successful ti_sci_get_handle
2169 * Return: 0 is successfully released
2170 * if an error pointer was passed, it returns the error value back,
2171 * if null was passed, it returns -EINVAL;
2173 int ti_sci_put_handle(const struct ti_sci_handle *handle)
2175 struct ti_sci_info *info;
2178 return PTR_ERR(handle);
2182 info = handle_to_ti_sci_info(handle);
2183 mutex_lock(&ti_sci_list_mutex);
2184 if (!WARN_ON(!info->users))
2186 mutex_unlock(&ti_sci_list_mutex);
2190 EXPORT_SYMBOL_GPL(ti_sci_put_handle);
2192 static void devm_ti_sci_release(struct device *dev, void *res)
2194 const struct ti_sci_handle **ptr = res;
2195 const struct ti_sci_handle *handle = *ptr;
2198 ret = ti_sci_put_handle(handle);
2200 dev_err(dev, "failed to put handle %d\n", ret);
2204 * devm_ti_sci_get_handle() - Managed get handle
2205 * @dev: device for which we want SCI handle for.
2207 * NOTE: This releases the handle once the device resources are
2208 * no longer needed. MUST NOT BE released with ti_sci_put_handle.
2209 * The function does not track individual clients of the framework
2210 * and is expected to be maintained by caller of TI SCI protocol library.
2212 * Return: 0 if all went fine, else corresponding error.
2214 const struct ti_sci_handle *devm_ti_sci_get_handle(struct device *dev)
2216 const struct ti_sci_handle **ptr;
2217 const struct ti_sci_handle *handle;
2219 ptr = devres_alloc(devm_ti_sci_release, sizeof(*ptr), GFP_KERNEL);
2221 return ERR_PTR(-ENOMEM);
2222 handle = ti_sci_get_handle(dev);
2224 if (!IS_ERR(handle)) {
2226 devres_add(dev, ptr);
2233 EXPORT_SYMBOL_GPL(devm_ti_sci_get_handle);
2236 * ti_sci_get_by_phandle() - Get the TI SCI handle using DT phandle
2238 * @property: property name containing phandle on TISCI node
2240 * NOTE: The function does not track individual clients of the framework
2241 * and is expected to be maintained by caller of TI SCI protocol library.
2242 * ti_sci_put_handle must be balanced with successful ti_sci_get_by_phandle
2243 * Return: pointer to handle if successful, else:
2244 * -EPROBE_DEFER if the instance is not ready
2245 * -ENODEV if the required node handler is missing
2246 * -EINVAL if invalid conditions are encountered.
2248 const struct ti_sci_handle *ti_sci_get_by_phandle(struct device_node *np,
2249 const char *property)
2251 struct ti_sci_handle *handle = NULL;
2252 struct device_node *ti_sci_np;
2253 struct ti_sci_info *info;
2254 struct list_head *p;
2257 pr_err("I need a device pointer\n");
2258 return ERR_PTR(-EINVAL);
2261 ti_sci_np = of_parse_phandle(np, property, 0);
2263 return ERR_PTR(-ENODEV);
2265 mutex_lock(&ti_sci_list_mutex);
2266 list_for_each(p, &ti_sci_list) {
2267 info = list_entry(p, struct ti_sci_info, node);
2268 if (ti_sci_np == info->dev->of_node) {
2269 handle = &info->handle;
2274 mutex_unlock(&ti_sci_list_mutex);
2275 of_node_put(ti_sci_np);
2278 return ERR_PTR(-EPROBE_DEFER);
2282 EXPORT_SYMBOL_GPL(ti_sci_get_by_phandle);
2285 * devm_ti_sci_get_by_phandle() - Managed get handle using phandle
2286 * @dev: Device pointer requesting TISCI handle
2287 * @property: property name containing phandle on TISCI node
2289 * NOTE: This releases the handle once the device resources are
2290 * no longer needed. MUST NOT BE released with ti_sci_put_handle.
2291 * The function does not track individual clients of the framework
2292 * and is expected to be maintained by caller of TI SCI protocol library.
2294 * Return: 0 if all went fine, else corresponding error.
2296 const struct ti_sci_handle *devm_ti_sci_get_by_phandle(struct device *dev,
2297 const char *property)
2299 const struct ti_sci_handle *handle;
2300 const struct ti_sci_handle **ptr;
2302 ptr = devres_alloc(devm_ti_sci_release, sizeof(*ptr), GFP_KERNEL);
2304 return ERR_PTR(-ENOMEM);
2305 handle = ti_sci_get_by_phandle(dev_of_node(dev), property);
2307 if (!IS_ERR(handle)) {
2309 devres_add(dev, ptr);
2316 EXPORT_SYMBOL_GPL(devm_ti_sci_get_by_phandle);
2319 * ti_sci_get_free_resource() - Get a free resource from TISCI resource.
2320 * @res: Pointer to the TISCI resource
2322 * Return: resource num if all went ok else TI_SCI_RESOURCE_NULL.
2324 u16 ti_sci_get_free_resource(struct ti_sci_resource *res)
2326 unsigned long flags;
2329 raw_spin_lock_irqsave(&res->lock, flags);
2330 for (set = 0; set < res->sets; set++) {
2331 free_bit = find_first_zero_bit(res->desc[set].res_map,
2332 res->desc[set].num);
2333 if (free_bit != res->desc[set].num) {
2334 set_bit(free_bit, res->desc[set].res_map);
2335 raw_spin_unlock_irqrestore(&res->lock, flags);
2336 return res->desc[set].start + free_bit;
2339 raw_spin_unlock_irqrestore(&res->lock, flags);
2341 return TI_SCI_RESOURCE_NULL;
2343 EXPORT_SYMBOL_GPL(ti_sci_get_free_resource);
2346 * ti_sci_release_resource() - Release a resource from TISCI resource.
2347 * @res: Pointer to the TISCI resource
2348 * @id: Resource id to be released.
2350 void ti_sci_release_resource(struct ti_sci_resource *res, u16 id)
2352 unsigned long flags;
2355 raw_spin_lock_irqsave(&res->lock, flags);
2356 for (set = 0; set < res->sets; set++) {
2357 if (res->desc[set].start <= id &&
2358 (res->desc[set].num + res->desc[set].start) > id)
2359 clear_bit(id - res->desc[set].start,
2360 res->desc[set].res_map);
2362 raw_spin_unlock_irqrestore(&res->lock, flags);
2364 EXPORT_SYMBOL_GPL(ti_sci_release_resource);
2367 * ti_sci_get_num_resources() - Get the number of resources in TISCI resource
2368 * @res: Pointer to the TISCI resource
2370 * Return: Total number of available resources.
2372 u32 ti_sci_get_num_resources(struct ti_sci_resource *res)
2376 for (set = 0; set < res->sets; set++)
2377 count += res->desc[set].num;
2381 EXPORT_SYMBOL_GPL(ti_sci_get_num_resources);
2384 * devm_ti_sci_get_of_resource() - Get a TISCI resource assigned to a device
2385 * @handle: TISCI handle
2386 * @dev: Device pointer to which the resource is assigned
2387 * @dev_id: TISCI device id to which the resource is assigned
2388 * @of_prop: property name by which the resource are represented
2390 * Return: Pointer to ti_sci_resource if all went well else appropriate
2393 struct ti_sci_resource *
2394 devm_ti_sci_get_of_resource(const struct ti_sci_handle *handle,
2395 struct device *dev, u32 dev_id, char *of_prop)
2397 struct ti_sci_resource *res;
2398 u32 resource_subtype;
2401 res = devm_kzalloc(dev, sizeof(*res), GFP_KERNEL);
2403 return ERR_PTR(-ENOMEM);
2405 ret = of_property_count_elems_of_size(dev_of_node(dev), of_prop,
2408 dev_err(dev, "%s resource type ids not available\n", of_prop);
2409 return ERR_PTR(ret);
2413 res->desc = devm_kcalloc(dev, res->sets, sizeof(*res->desc),
2416 return ERR_PTR(-ENOMEM);
2418 for (i = 0; i < res->sets; i++) {
2419 ret = of_property_read_u32_index(dev_of_node(dev), of_prop, i,
2422 return ERR_PTR(-EINVAL);
2424 ret = handle->ops.rm_core_ops.get_range(handle, dev_id,
2426 &res->desc[i].start,
2429 dev_err(dev, "dev = %d subtype %d not allocated for this host\n",
2430 dev_id, resource_subtype);
2431 return ERR_PTR(ret);
2434 dev_dbg(dev, "dev = %d, subtype = %d, start = %d, num = %d\n",
2435 dev_id, resource_subtype, res->desc[i].start,
2438 res->desc[i].res_map =
2439 devm_kzalloc(dev, BITS_TO_LONGS(res->desc[i].num) *
2440 sizeof(*res->desc[i].res_map), GFP_KERNEL);
2441 if (!res->desc[i].res_map)
2442 return ERR_PTR(-ENOMEM);
2444 raw_spin_lock_init(&res->lock);
2449 static int tisci_reboot_handler(struct notifier_block *nb, unsigned long mode,
2452 struct ti_sci_info *info = reboot_to_ti_sci_info(nb);
2453 const struct ti_sci_handle *handle = &info->handle;
2455 ti_sci_cmd_core_reboot(handle);
2457 /* call fail OR pass, we should not be here in the first place */
2461 /* Description for K2G */
2462 static const struct ti_sci_desc ti_sci_pmmc_k2g_desc = {
2463 .default_host_id = 2,
2464 /* Conservative duration */
2465 .max_rx_timeout_ms = 1000,
2466 /* Limited by MBOX_TX_QUEUE_LEN. K2G can handle upto 128 messages! */
2469 .rm_type_map = NULL,
2472 static struct ti_sci_rm_type_map ti_sci_am654_rm_type_map[] = {
2473 {.dev_id = 56, .type = 0x00b}, /* GIC_IRQ */
2474 {.dev_id = 179, .type = 0x000}, /* MAIN_NAV_UDMASS_IA0 */
2475 {.dev_id = 187, .type = 0x009}, /* MAIN_NAV_RA */
2476 {.dev_id = 188, .type = 0x006}, /* MAIN_NAV_UDMAP */
2477 {.dev_id = 194, .type = 0x007}, /* MCU_NAV_UDMAP */
2478 {.dev_id = 195, .type = 0x00a}, /* MCU_NAV_RA */
2479 {.dev_id = 0, .type = 0x000}, /* end of table */
2482 /* Description for AM654 */
2483 static const struct ti_sci_desc ti_sci_pmmc_am654_desc = {
2484 .default_host_id = 12,
2485 /* Conservative duration */
2486 .max_rx_timeout_ms = 10000,
2487 /* Limited by MBOX_TX_QUEUE_LEN. K2G can handle upto 128 messages! */
2490 .rm_type_map = ti_sci_am654_rm_type_map,
2493 static const struct of_device_id ti_sci_of_match[] = {
2494 {.compatible = "ti,k2g-sci", .data = &ti_sci_pmmc_k2g_desc},
2495 {.compatible = "ti,am654-sci", .data = &ti_sci_pmmc_am654_desc},
2498 MODULE_DEVICE_TABLE(of, ti_sci_of_match);
2500 static int ti_sci_probe(struct platform_device *pdev)
2502 struct device *dev = &pdev->dev;
2503 const struct of_device_id *of_id;
2504 const struct ti_sci_desc *desc;
2505 struct ti_sci_xfer *xfer;
2506 struct ti_sci_info *info = NULL;
2507 struct ti_sci_xfers_info *minfo;
2508 struct mbox_client *cl;
2514 of_id = of_match_device(ti_sci_of_match, dev);
2516 dev_err(dev, "OF data missing\n");
2521 info = devm_kzalloc(dev, sizeof(*info), GFP_KERNEL);
2527 ret = of_property_read_u32(dev->of_node, "ti,host-id", &h_id);
2528 /* if the property is not present in DT, use a default from desc */
2530 info->host_id = info->desc->default_host_id;
2533 dev_warn(dev, "Host ID 0 is reserved for firmware\n");
2534 info->host_id = info->desc->default_host_id;
2536 info->host_id = h_id;
2540 reboot = of_property_read_bool(dev->of_node,
2541 "ti,system-reboot-controller");
2542 INIT_LIST_HEAD(&info->node);
2543 minfo = &info->minfo;
2546 * Pre-allocate messages
2547 * NEVER allocate more than what we can indicate in hdr.seq
2548 * if we have data description bug, force a fix..
2550 if (WARN_ON(desc->max_msgs >=
2551 1 << 8 * sizeof(((struct ti_sci_msg_hdr *)0)->seq)))
2554 minfo->xfer_block = devm_kcalloc(dev,
2556 sizeof(*minfo->xfer_block),
2558 if (!minfo->xfer_block)
2561 minfo->xfer_alloc_table = devm_kcalloc(dev,
2562 BITS_TO_LONGS(desc->max_msgs),
2563 sizeof(unsigned long),
2565 if (!minfo->xfer_alloc_table)
2567 bitmap_zero(minfo->xfer_alloc_table, desc->max_msgs);
2569 /* Pre-initialize the buffer pointer to pre-allocated buffers */
2570 for (i = 0, xfer = minfo->xfer_block; i < desc->max_msgs; i++, xfer++) {
2571 xfer->xfer_buf = devm_kcalloc(dev, 1, desc->max_msg_size,
2573 if (!xfer->xfer_buf)
2576 xfer->tx_message.buf = xfer->xfer_buf;
2577 init_completion(&xfer->done);
2580 ret = ti_sci_debugfs_create(pdev, info);
2582 dev_warn(dev, "Failed to create debug file\n");
2584 platform_set_drvdata(pdev, info);
2588 cl->tx_block = false;
2589 cl->rx_callback = ti_sci_rx_callback;
2590 cl->knows_txdone = true;
2592 spin_lock_init(&minfo->xfer_lock);
2593 sema_init(&minfo->sem_xfer_count, desc->max_msgs);
2595 info->chan_rx = mbox_request_channel_byname(cl, "rx");
2596 if (IS_ERR(info->chan_rx)) {
2597 ret = PTR_ERR(info->chan_rx);
2601 info->chan_tx = mbox_request_channel_byname(cl, "tx");
2602 if (IS_ERR(info->chan_tx)) {
2603 ret = PTR_ERR(info->chan_tx);
2606 ret = ti_sci_cmd_get_revision(info);
2608 dev_err(dev, "Unable to communicate with TISCI(%d)\n", ret);
2612 ti_sci_setup_ops(info);
2615 info->nb.notifier_call = tisci_reboot_handler;
2616 info->nb.priority = 128;
2618 ret = register_restart_handler(&info->nb);
2620 dev_err(dev, "reboot registration fail(%d)\n", ret);
2625 dev_info(dev, "ABI: %d.%d (firmware rev 0x%04x '%s')\n",
2626 info->handle.version.abi_major, info->handle.version.abi_minor,
2627 info->handle.version.firmware_revision,
2628 info->handle.version.firmware_description);
2630 mutex_lock(&ti_sci_list_mutex);
2631 list_add_tail(&info->node, &ti_sci_list);
2632 mutex_unlock(&ti_sci_list_mutex);
2634 return of_platform_populate(dev->of_node, NULL, NULL, dev);
2636 if (!IS_ERR(info->chan_tx))
2637 mbox_free_channel(info->chan_tx);
2638 if (!IS_ERR(info->chan_rx))
2639 mbox_free_channel(info->chan_rx);
2640 debugfs_remove(info->d);
2644 static int ti_sci_remove(struct platform_device *pdev)
2646 struct ti_sci_info *info;
2647 struct device *dev = &pdev->dev;
2650 of_platform_depopulate(dev);
2652 info = platform_get_drvdata(pdev);
2654 if (info->nb.notifier_call)
2655 unregister_restart_handler(&info->nb);
2657 mutex_lock(&ti_sci_list_mutex);
2661 list_del(&info->node);
2662 mutex_unlock(&ti_sci_list_mutex);
2665 ti_sci_debugfs_destroy(pdev, info);
2667 /* Safe to free channels since no more users */
2668 mbox_free_channel(info->chan_tx);
2669 mbox_free_channel(info->chan_rx);
2675 static struct platform_driver ti_sci_driver = {
2676 .probe = ti_sci_probe,
2677 .remove = ti_sci_remove,
2680 .of_match_table = of_match_ptr(ti_sci_of_match),
2683 module_platform_driver(ti_sci_driver);
2685 MODULE_LICENSE("GPL v2");
2686 MODULE_DESCRIPTION("TI System Control Interface(SCI) driver");
2687 MODULE_AUTHOR("Nishanth Menon");
2688 MODULE_ALIAS("platform:ti-sci");