1*91f16700Schasinglulu /* 2*91f16700Schasinglulu * Copyright (c) 2022, Arm Limited. All rights reserved. 3*91f16700Schasinglulu * 4*91f16700Schasinglulu * SPDX-License-Identifier: BSD-3-Clause 5*91f16700Schasinglulu * 6*91f16700Schasinglulu */ 7*91f16700Schasinglulu 8*91f16700Schasinglulu #ifndef __RSS_COMMS_PROTOCOL_H__ 9*91f16700Schasinglulu #define __RSS_COMMS_PROTOCOL_H__ 10*91f16700Schasinglulu 11*91f16700Schasinglulu #include <cdefs.h> 12*91f16700Schasinglulu #include <stdint.h> 13*91f16700Schasinglulu 14*91f16700Schasinglulu #include <psa/client.h> 15*91f16700Schasinglulu #include "rss_comms_protocol_embed.h" 16*91f16700Schasinglulu #include "rss_comms_protocol_pointer_access.h" 17*91f16700Schasinglulu 18*91f16700Schasinglulu enum rss_comms_protocol_version_t { 19*91f16700Schasinglulu RSS_COMMS_PROTOCOL_EMBED = 0, 20*91f16700Schasinglulu RSS_COMMS_PROTOCOL_POINTER_ACCESS = 1, 21*91f16700Schasinglulu }; 22*91f16700Schasinglulu 23*91f16700Schasinglulu struct __packed serialized_rss_comms_header_t { 24*91f16700Schasinglulu uint8_t protocol_ver; 25*91f16700Schasinglulu uint8_t seq_num; 26*91f16700Schasinglulu uint16_t client_id; 27*91f16700Schasinglulu }; 28*91f16700Schasinglulu 29*91f16700Schasinglulu /* MHU message passed from Host to RSS to deliver a PSA client call */ 30*91f16700Schasinglulu struct __packed serialized_rss_comms_msg_t { 31*91f16700Schasinglulu struct serialized_rss_comms_header_t header; 32*91f16700Schasinglulu union __packed { 33*91f16700Schasinglulu struct rss_embed_msg_t embed; 34*91f16700Schasinglulu struct rss_pointer_access_msg_t pointer_access; 35*91f16700Schasinglulu } msg; 36*91f16700Schasinglulu }; 37*91f16700Schasinglulu 38*91f16700Schasinglulu /* MHU reply message to hold the PSA client reply result returned by RSS */ 39*91f16700Schasinglulu struct __packed serialized_rss_comms_reply_t { 40*91f16700Schasinglulu struct serialized_rss_comms_header_t header; 41*91f16700Schasinglulu union __packed { 42*91f16700Schasinglulu struct rss_embed_reply_t embed; 43*91f16700Schasinglulu struct rss_pointer_access_reply_t pointer_access; 44*91f16700Schasinglulu } reply; 45*91f16700Schasinglulu }; 46*91f16700Schasinglulu 47*91f16700Schasinglulu /* in_len and out_len are uint8_ts, therefore if there are more than 255 iovecs 48*91f16700Schasinglulu * an error may occur. 49*91f16700Schasinglulu */ 50*91f16700Schasinglulu CASSERT(PSA_MAX_IOVEC <= UINT8_MAX, assert_rss_comms_max_iovec_too_large); 51*91f16700Schasinglulu 52*91f16700Schasinglulu psa_status_t rss_protocol_serialize_msg(psa_handle_t handle, 53*91f16700Schasinglulu int16_t type, 54*91f16700Schasinglulu const psa_invec *in_vec, 55*91f16700Schasinglulu uint8_t in_len, 56*91f16700Schasinglulu const psa_outvec *out_vec, 57*91f16700Schasinglulu uint8_t out_len, 58*91f16700Schasinglulu struct serialized_rss_comms_msg_t *msg, 59*91f16700Schasinglulu size_t *msg_len); 60*91f16700Schasinglulu 61*91f16700Schasinglulu psa_status_t rss_protocol_deserialize_reply(psa_outvec *out_vec, 62*91f16700Schasinglulu uint8_t out_len, 63*91f16700Schasinglulu psa_status_t *return_val, 64*91f16700Schasinglulu const struct serialized_rss_comms_reply_t *reply, 65*91f16700Schasinglulu size_t reply_size); 66*91f16700Schasinglulu 67*91f16700Schasinglulu #endif /* __RSS_COMMS_PROTOCOL_H__ */ 68