xref: /aosp_15_r20/system/chre/util/pigweed/chre_channel_output.cc (revision 84e339476a462649f82315436d70fd732297a399)
1*84e33947SAndroid Build Coastguard Worker /*
2*84e33947SAndroid Build Coastguard Worker  * Copyright (C) 2022 The Android Open Source Project
3*84e33947SAndroid Build Coastguard Worker  *
4*84e33947SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*84e33947SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*84e33947SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*84e33947SAndroid Build Coastguard Worker  *
8*84e33947SAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*84e33947SAndroid Build Coastguard Worker  *
10*84e33947SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*84e33947SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*84e33947SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*84e33947SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*84e33947SAndroid Build Coastguard Worker  * limitations under the License.
15*84e33947SAndroid Build Coastguard Worker  */
16*84e33947SAndroid Build Coastguard Worker 
17*84e33947SAndroid Build Coastguard Worker #include "chre/util/pigweed/chre_channel_output.h"
18*84e33947SAndroid Build Coastguard Worker 
19*84e33947SAndroid Build Coastguard Worker #include <cstdint>
20*84e33947SAndroid Build Coastguard Worker 
21*84e33947SAndroid Build Coastguard Worker #include "chre/util/nanoapp/callbacks.h"
22*84e33947SAndroid Build Coastguard Worker #include "chre/util/pigweed/rpc_helper.h"
23*84e33947SAndroid Build Coastguard Worker 
24*84e33947SAndroid Build Coastguard Worker namespace chre {
25*84e33947SAndroid Build Coastguard Worker namespace {
26*84e33947SAndroid Build Coastguard Worker 
nappMessageFreeCb(uint16_t,void * eventData)27*84e33947SAndroid Build Coastguard Worker void nappMessageFreeCb(uint16_t /* eventType */, void *eventData) {
28*84e33947SAndroid Build Coastguard Worker   chreHeapFree(eventData);
29*84e33947SAndroid Build Coastguard Worker }
30*84e33947SAndroid Build Coastguard Worker 
31*84e33947SAndroid Build Coastguard Worker /**
32*84e33947SAndroid Build Coastguard Worker  * Sends the buffer to the nanoapp.
33*84e33947SAndroid Build Coastguard Worker  *
34*84e33947SAndroid Build Coastguard Worker  * The buffer is first wrapped into a ChrePigweedNanoappMessage struct.
35*84e33947SAndroid Build Coastguard Worker  *
36*84e33947SAndroid Build Coastguard Worker  * @param targetInstanceId The nanoapp to send the message to
37*84e33947SAndroid Build Coastguard Worker  * @param eventType The event to send to the nanoapp
38*84e33947SAndroid Build Coastguard Worker  * @param buffer The buffer to send
39*84e33947SAndroid Build Coastguard Worker  * @return The status of the operation
40*84e33947SAndroid Build Coastguard Worker  */
sendToNanoapp(uint32_t targetInstanceId,uint16_t eventType,pw::span<const std::byte> buffer)41*84e33947SAndroid Build Coastguard Worker pw::Status sendToNanoapp(uint32_t targetInstanceId, uint16_t eventType,
42*84e33947SAndroid Build Coastguard Worker                          pw::span<const std::byte> buffer) {
43*84e33947SAndroid Build Coastguard Worker   CHRE_ASSERT(targetInstanceId != 0);
44*84e33947SAndroid Build Coastguard Worker 
45*84e33947SAndroid Build Coastguard Worker   if (buffer.size() > 0) {
46*84e33947SAndroid Build Coastguard Worker     auto *data = static_cast<ChrePigweedNanoappMessage *>(
47*84e33947SAndroid Build Coastguard Worker         chreHeapAlloc(static_cast<uint32_t>(
48*84e33947SAndroid Build Coastguard Worker             buffer.size() + sizeof(ChrePigweedNanoappMessage))));
49*84e33947SAndroid Build Coastguard Worker     if (data == nullptr) {
50*84e33947SAndroid Build Coastguard Worker       return PW_STATUS_RESOURCE_EXHAUSTED;
51*84e33947SAndroid Build Coastguard Worker     }
52*84e33947SAndroid Build Coastguard Worker 
53*84e33947SAndroid Build Coastguard Worker     data->msgSize = buffer.size();
54*84e33947SAndroid Build Coastguard Worker     memcpy(data->msg, buffer.data(), buffer.size());
55*84e33947SAndroid Build Coastguard Worker 
56*84e33947SAndroid Build Coastguard Worker     if (!chreSendEvent(eventType, data, nappMessageFreeCb, targetInstanceId)) {
57*84e33947SAndroid Build Coastguard Worker       return PW_STATUS_INVALID_ARGUMENT;
58*84e33947SAndroid Build Coastguard Worker     }
59*84e33947SAndroid Build Coastguard Worker   }
60*84e33947SAndroid Build Coastguard Worker 
61*84e33947SAndroid Build Coastguard Worker   return PW_STATUS_OK;
62*84e33947SAndroid Build Coastguard Worker }
63*84e33947SAndroid Build Coastguard Worker 
64*84e33947SAndroid Build Coastguard Worker }  // namespace
65*84e33947SAndroid Build Coastguard Worker 
setClient(uint32_t nanoappInstanceId)66*84e33947SAndroid Build Coastguard Worker void ChreServerNanoappChannelOutput::setClient(uint32_t nanoappInstanceId) {
67*84e33947SAndroid Build Coastguard Worker   CHRE_ASSERT(nanoappInstanceId <= kRpcNanoappMaxId);
68*84e33947SAndroid Build Coastguard Worker   if (nanoappInstanceId <= kRpcNanoappMaxId) {
69*84e33947SAndroid Build Coastguard Worker     mClientInstanceId = static_cast<uint16_t>(nanoappInstanceId);
70*84e33947SAndroid Build Coastguard Worker   } else {
71*84e33947SAndroid Build Coastguard Worker     mClientInstanceId = 0;
72*84e33947SAndroid Build Coastguard Worker   }
73*84e33947SAndroid Build Coastguard Worker }
74*84e33947SAndroid Build Coastguard Worker 
MaximumTransmissionUnit()75*84e33947SAndroid Build Coastguard Worker size_t ChreServerNanoappChannelOutput::MaximumTransmissionUnit() {
76*84e33947SAndroid Build Coastguard Worker   return CHRE_MESSAGE_TO_HOST_MAX_SIZE - sizeof(ChrePigweedNanoappMessage);
77*84e33947SAndroid Build Coastguard Worker }
78*84e33947SAndroid Build Coastguard Worker 
Send(pw::span<const std::byte> buffer)79*84e33947SAndroid Build Coastguard Worker pw::Status ChreServerNanoappChannelOutput::Send(
80*84e33947SAndroid Build Coastguard Worker     pw::span<const std::byte> buffer) {
81*84e33947SAndroid Build Coastguard Worker   // The permission is not enforced across nanoapps but we still need to
82*84e33947SAndroid Build Coastguard Worker   // reset the value as it is only applicable to the next message.
83*84e33947SAndroid Build Coastguard Worker   mPermission.getAndReset();
84*84e33947SAndroid Build Coastguard Worker 
85*84e33947SAndroid Build Coastguard Worker   return sendToNanoapp(mClientInstanceId, CHRE_EVENT_RPC_RESPONSE, buffer);
86*84e33947SAndroid Build Coastguard Worker }
87*84e33947SAndroid Build Coastguard Worker 
setServer(uint32_t instanceId)88*84e33947SAndroid Build Coastguard Worker void ChreClientNanoappChannelOutput::setServer(uint32_t instanceId) {
89*84e33947SAndroid Build Coastguard Worker   CHRE_ASSERT(instanceId <= kRpcNanoappMaxId);
90*84e33947SAndroid Build Coastguard Worker   if (instanceId <= kRpcNanoappMaxId) {
91*84e33947SAndroid Build Coastguard Worker     mServerInstanceId = static_cast<uint16_t>(instanceId);
92*84e33947SAndroid Build Coastguard Worker   } else {
93*84e33947SAndroid Build Coastguard Worker     mServerInstanceId = 0;
94*84e33947SAndroid Build Coastguard Worker   }
95*84e33947SAndroid Build Coastguard Worker }
96*84e33947SAndroid Build Coastguard Worker 
MaximumTransmissionUnit()97*84e33947SAndroid Build Coastguard Worker size_t ChreClientNanoappChannelOutput::MaximumTransmissionUnit() {
98*84e33947SAndroid Build Coastguard Worker   return CHRE_MESSAGE_TO_HOST_MAX_SIZE - sizeof(ChrePigweedNanoappMessage);
99*84e33947SAndroid Build Coastguard Worker }
100*84e33947SAndroid Build Coastguard Worker 
Send(pw::span<const std::byte> buffer)101*84e33947SAndroid Build Coastguard Worker pw::Status ChreClientNanoappChannelOutput::Send(
102*84e33947SAndroid Build Coastguard Worker     pw::span<const std::byte> buffer) {
103*84e33947SAndroid Build Coastguard Worker   return sendToNanoapp(mServerInstanceId, CHRE_EVENT_RPC_REQUEST, buffer);
104*84e33947SAndroid Build Coastguard Worker }
105*84e33947SAndroid Build Coastguard Worker 
setHostEndpoint(uint16_t hostEndpoint)106*84e33947SAndroid Build Coastguard Worker void ChreServerHostChannelOutput::setHostEndpoint(uint16_t hostEndpoint) {
107*84e33947SAndroid Build Coastguard Worker   mEndpointId = hostEndpoint;
108*84e33947SAndroid Build Coastguard Worker }
109*84e33947SAndroid Build Coastguard Worker 
MaximumTransmissionUnit()110*84e33947SAndroid Build Coastguard Worker size_t ChreServerHostChannelOutput::MaximumTransmissionUnit() {
111*84e33947SAndroid Build Coastguard Worker   return CHRE_MESSAGE_TO_HOST_MAX_SIZE - sizeof(ChrePigweedNanoappMessage);
112*84e33947SAndroid Build Coastguard Worker }
113*84e33947SAndroid Build Coastguard Worker 
Send(pw::span<const std::byte> buffer)114*84e33947SAndroid Build Coastguard Worker pw::Status ChreServerHostChannelOutput::Send(pw::span<const std::byte> buffer) {
115*84e33947SAndroid Build Coastguard Worker   CHRE_ASSERT(mEndpointId != CHRE_HOST_ENDPOINT_UNSPECIFIED);
116*84e33947SAndroid Build Coastguard Worker   pw::Status returnCode = PW_STATUS_OK;
117*84e33947SAndroid Build Coastguard Worker 
118*84e33947SAndroid Build Coastguard Worker   if (buffer.size() > 0) {
119*84e33947SAndroid Build Coastguard Worker     uint32_t permission = mPermission.getAndReset();
120*84e33947SAndroid Build Coastguard Worker     uint8_t *data = static_cast<uint8_t *>(
121*84e33947SAndroid Build Coastguard Worker         chreHeapAlloc(static_cast<uint32_t>(buffer.size())));
122*84e33947SAndroid Build Coastguard Worker     if (data == nullptr) {
123*84e33947SAndroid Build Coastguard Worker       returnCode = PW_STATUS_RESOURCE_EXHAUSTED;
124*84e33947SAndroid Build Coastguard Worker     } else {
125*84e33947SAndroid Build Coastguard Worker       memcpy(data, buffer.data(), buffer.size());
126*84e33947SAndroid Build Coastguard Worker       if (!chreSendMessageWithPermissions(
127*84e33947SAndroid Build Coastguard Worker               data, buffer.size(), CHRE_MESSAGE_TYPE_RPC, mEndpointId,
128*84e33947SAndroid Build Coastguard Worker               permission, heapFreeMessageCallback)) {
129*84e33947SAndroid Build Coastguard Worker         returnCode = PW_STATUS_INVALID_ARGUMENT;
130*84e33947SAndroid Build Coastguard Worker       }
131*84e33947SAndroid Build Coastguard Worker     }
132*84e33947SAndroid Build Coastguard Worker   }
133*84e33947SAndroid Build Coastguard Worker 
134*84e33947SAndroid Build Coastguard Worker   return returnCode;
135*84e33947SAndroid Build Coastguard Worker }
136*84e33947SAndroid Build Coastguard Worker 
137*84e33947SAndroid Build Coastguard Worker }  // namespace chre
138