| Imre Kis | 9df392c | 2023-09-14 13:29:09 +0200 | [diff] [blame] | 1 | '------------------------------------------------------------------------------- |
| 2 | ' Copyright (c) 2023, Arm Limited and Contributors. All rights reserved. |
| 3 | ' |
| 4 | ' SPDX-License-Identifier: BSD-3-Clause |
| 5 | ' |
| 6 | '------------------------------------------------------------------------------- |
| 7 | |
| 8 | @startuml TS RPC call sequence |
| 9 | |
| 10 | autoactivate on |
| 11 | |
| 12 | participant "Service caller" as service_caller |
| 13 | participant "RPC caller session" as rpc_session |
| 14 | participant "TS RPC caller" as rpc_caller |
| 15 | participant "SPMC" as spmc |
| 16 | participant "TS RPC endpoint" as endpoint |
| 17 | participant "Service" as service |
| 18 | |
| 19 | service_caller -> rpc_session: open(service_uuid) |
| 20 | |
| 21 | ' Sesssion open |
| 22 | rpc_session -> rpc_caller: find_and_open_session(service_uuid) |
| 23 | |
| 24 | rpc_caller -> spmc: FFA_PARTITION_INFO_GET(ts_rpc_uuid) |
| 25 | spmc --> rpc_caller: FF-A endpoint_id |
| 26 | |
| 27 | rpc_caller -> endpoint: TS_RPC_VERSION_GET |
| 28 | endpoint --> rpc_caller: TS RPC protocol version |
| 29 | |
| 30 | rpc_caller -> endpoint: TS_RPC_SERVICE_INFO_GET(service_uuid) |
| 31 | endpoint --> rpc_caller: Service interface_id |
| 32 | |
| 33 | rpc_caller --> rpc_session: TS RPC status |
| 34 | |
| 35 | rpc_session --> service_caller: TS RPC status |
| 36 | |
| 37 | ' Begin |
| 38 | service_caller -> rpc_session: begin(request_length, response_max_length) |
| 39 | |
| 40 | rpc_session -> rpc_session: allocate_buffer(MAX(request_length, response_max_length)) |
| 41 | rpc_session --> rpc_session: buffer |
| 42 | |
| 43 | rpc_session -> rpc_caller: create_shared_memory(endpoint_id, buffer) |
| 44 | |
| 45 | rpc_caller -> spmc: FFA_MEM_SHARE(endpoint_id, buffer) |
| 46 | spmc --> rpc_caller: memory_handle, memory_tag |
| 47 | |
| 48 | rpc_caller -> endpoint: TS_RPC_MEM_RETRIEVE(memory_handle, memory_tag) |
| 49 | |
| 50 | endpoint -> spmc: FFA_MEM_RETRIEVE(memory_handle, memory_tag) |
| 51 | spmc --> endpoint: buffer |
| 52 | |
| 53 | endpoint --> rpc_caller: TS RPC status |
| 54 | |
| 55 | rpc_caller --> rpc_session: TS RPC status, shared_memory |
| 56 | |
| 57 | rpc_session --> service_caller: Request buffer |
| 58 | |
| 59 | ' Serialize |
| 60 | service_caller -> service_caller: Serialize parameters to request buffer |
| 61 | service_caller --> service_caller |
| 62 | |
| 63 | ' Invoke |
| 64 | service_caller -> rpc_session: invoke(opcode) |
| 65 | |
| 66 | rpc_session -> rpc_caller: call(opcode, shared_memory, request_length) |
| 67 | |
| 68 | rpc_caller -> endpoint: service_call(interface_id, opcode, memory_handle, request_length) |
| 69 | |
| 70 | endpoint -> service: service_call(opcode, request) |
| 71 | service --> endpoint: service status, response |
| 72 | |
| 73 | endpoint --> rpc_caller: TS RPC status, service status, response length |
| 74 | |
| 75 | rpc_caller --> rpc_session: TS RPC status, service status, response length |
| 76 | |
| 77 | rpc_session --> service_caller: TS RPC status, service status, response |
| 78 | |
| 79 | ' Deserialize |
| 80 | service_caller -> service_caller: Deserialize return values from the response buffer |
| 81 | service_caller --> service_caller |
| 82 | |
| 83 | ' End |
| 84 | service_caller -> rpc_session: end() |
| 85 | |
| 86 | rpc_session -> rpc_caller: release_shared_memory(shared_memory) |
| 87 | |
| 88 | rpc_caller -> endpoint: TS_RPC_MEM_RELINQUISH(memory_handle) |
| 89 | |
| 90 | endpoint -> spmc: FFA_MEMORY_RELINQUISH(memory_handle) |
| 91 | spmc --> endpoint: FFA_SUCCESS |
| 92 | |
| 93 | endpoint --> rpc_caller: TS RPC status |
| 94 | |
| 95 | rpc_caller -> spmc: FFA_MEM_RECLAIM(memory_handle) |
| 96 | spmc --> rpc_caller: FFA_SUCCESS |
| 97 | |
| 98 | rpc_caller -> rpc_caller: free(buffer) |
| 99 | rpc_caller --> rpc_caller |
| 100 | |
| 101 | rpc_caller --> rpc_session: TS RPC status |
| 102 | |
| 103 | rpc_session --> service_caller: TS RPC status |
| 104 | |
| 105 | service_caller -> rpc_session: close() |
| 106 | rpc_session --> service_caller: TS RPC status |
| 107 | @enduml |