msg.c 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * For transports using message passing.
  4. *
  5. * Derived from shm.c.
  6. *
  7. * Copyright (C) 2019-2021 ARM Ltd.
  8. * Copyright (C) 2020-2021 OpenSynergy GmbH
  9. */
  10. #include <linux/types.h>
  11. #include "common.h"
  12. /*
  13. * struct scmi_msg_payld - Transport SDU layout
  14. *
  15. * The SCMI specification requires all parameters, message headers, return
  16. * arguments or any protocol data to be expressed in little endian format only.
  17. */
  18. struct scmi_msg_payld {
  19. __le32 msg_header;
  20. __le32 msg_payload[];
  21. };
  22. /**
  23. * msg_command_size() - Actual size of transport SDU for command.
  24. *
  25. * @xfer: message which core has prepared for sending
  26. *
  27. * Return: transport SDU size.
  28. */
  29. size_t msg_command_size(struct scmi_xfer *xfer)
  30. {
  31. return sizeof(struct scmi_msg_payld) + xfer->tx.len;
  32. }
  33. /**
  34. * msg_response_size() - Maximum size of transport SDU for response.
  35. *
  36. * @xfer: message which core has prepared for sending
  37. *
  38. * Return: transport SDU size.
  39. */
  40. size_t msg_response_size(struct scmi_xfer *xfer)
  41. {
  42. return sizeof(struct scmi_msg_payld) + sizeof(__le32) + xfer->rx.len;
  43. }
  44. /**
  45. * msg_tx_prepare() - Set up transport SDU for command.
  46. *
  47. * @msg: transport SDU for command
  48. * @xfer: message which is being sent
  49. */
  50. void msg_tx_prepare(struct scmi_msg_payld *msg, struct scmi_xfer *xfer)
  51. {
  52. msg->msg_header = cpu_to_le32(pack_scmi_header(&xfer->hdr));
  53. if (xfer->tx.buf)
  54. memcpy(msg->msg_payload, xfer->tx.buf, xfer->tx.len);
  55. }
  56. /**
  57. * msg_read_header() - Read SCMI header from transport SDU.
  58. *
  59. * @msg: transport SDU
  60. *
  61. * Return: SCMI header
  62. */
  63. u32 msg_read_header(struct scmi_msg_payld *msg)
  64. {
  65. return le32_to_cpu(msg->msg_header);
  66. }
  67. /**
  68. * msg_fetch_response() - Fetch response SCMI payload from transport SDU.
  69. *
  70. * @msg: transport SDU with response
  71. * @len: transport SDU size
  72. * @xfer: message being responded to
  73. */
  74. void msg_fetch_response(struct scmi_msg_payld *msg, size_t len,
  75. struct scmi_xfer *xfer)
  76. {
  77. size_t prefix_len = sizeof(*msg) + sizeof(msg->msg_payload[0]);
  78. xfer->hdr.status = le32_to_cpu(msg->msg_payload[0]);
  79. xfer->rx.len = min_t(size_t, xfer->rx.len,
  80. len >= prefix_len ? len - prefix_len : 0);
  81. /* Take a copy to the rx buffer.. */
  82. memcpy(xfer->rx.buf, &msg->msg_payload[1], xfer->rx.len);
  83. }
  84. /**
  85. * msg_fetch_notification() - Fetch notification payload from transport SDU.
  86. *
  87. * @msg: transport SDU with notification
  88. * @len: transport SDU size
  89. * @max_len: maximum SCMI payload size to fetch
  90. * @xfer: notification message
  91. */
  92. void msg_fetch_notification(struct scmi_msg_payld *msg, size_t len,
  93. size_t max_len, struct scmi_xfer *xfer)
  94. {
  95. xfer->rx.len = min_t(size_t, max_len,
  96. len >= sizeof(*msg) ? len - sizeof(*msg) : 0);
  97. /* Take a copy to the rx buffer.. */
  98. memcpy(xfer->rx.buf, msg->msg_payload, xfer->rx.len);
  99. }