xref: /aosp_15_r20/external/pigweed/pw_system/system_async_test.cc (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker // Copyright 2024 The Pigweed Authors
2*61c4878aSAndroid Build Coastguard Worker //
3*61c4878aSAndroid Build Coastguard Worker // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4*61c4878aSAndroid Build Coastguard Worker // use this file except in compliance with the License. You may obtain a copy of
5*61c4878aSAndroid Build Coastguard Worker // the License at
6*61c4878aSAndroid Build Coastguard Worker //
7*61c4878aSAndroid Build Coastguard Worker //     https://www.apache.org/licenses/LICENSE-2.0
8*61c4878aSAndroid Build Coastguard Worker //
9*61c4878aSAndroid Build Coastguard Worker // Unless required by applicable law or agreed to in writing, software
10*61c4878aSAndroid Build Coastguard Worker // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11*61c4878aSAndroid Build Coastguard Worker // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12*61c4878aSAndroid Build Coastguard Worker // License for the specific language governing permissions and limitations under
13*61c4878aSAndroid Build Coastguard Worker // the License.
14*61c4878aSAndroid Build Coastguard Worker 
15*61c4878aSAndroid Build Coastguard Worker #include <cstddef>
16*61c4878aSAndroid Build Coastguard Worker 
17*61c4878aSAndroid Build Coastguard Worker #include "pw_async2/dispatcher.h"
18*61c4878aSAndroid Build Coastguard Worker #include "pw_channel/loopback_channel.h"
19*61c4878aSAndroid Build Coastguard Worker #include "pw_log/log.h"
20*61c4878aSAndroid Build Coastguard Worker #include "pw_multibuf/simple_allocator_for_test.h"
21*61c4878aSAndroid Build Coastguard Worker #include "pw_system/system.h"
22*61c4878aSAndroid Build Coastguard Worker #include "pw_unit_test/framework.h"
23*61c4878aSAndroid Build Coastguard Worker 
24*61c4878aSAndroid Build Coastguard Worker namespace {
25*61c4878aSAndroid Build Coastguard Worker 
26*61c4878aSAndroid Build Coastguard Worker class : public pw::async2::Task {
DoPend(pw::async2::Context &)27*61c4878aSAndroid Build Coastguard Worker   pw::async2::Poll<> DoPend(pw::async2::Context&) override {
28*61c4878aSAndroid Build Coastguard Worker     return pw::async2::Ready();
29*61c4878aSAndroid Build Coastguard Worker   }
30*61c4878aSAndroid Build Coastguard Worker } my_task;
31*61c4878aSAndroid Build Coastguard Worker 
32*61c4878aSAndroid Build Coastguard Worker // DOCSTAG: [pw_system-async-example-main]
main()33*61c4878aSAndroid Build Coastguard Worker int main() {
34*61c4878aSAndroid Build Coastguard Worker   // First, do any required low-level platform initialization.
35*61c4878aSAndroid Build Coastguard Worker 
36*61c4878aSAndroid Build Coastguard Worker   // Initialize a channel to handle pw_system communications, including for
37*61c4878aSAndroid Build Coastguard Worker   // pw_rpc. This example uses LoopbackByteChannel, but a channel that actually
38*61c4878aSAndroid Build Coastguard Worker   // transmits data should be used instead.
39*61c4878aSAndroid Build Coastguard Worker   std::byte channel_buffer[128];
40*61c4878aSAndroid Build Coastguard Worker   pw::multibuf::SimpleAllocator alloc(channel_buffer, pw::System().allocator());
41*61c4878aSAndroid Build Coastguard Worker   pw::channel::LoopbackByteChannel channel(alloc);
42*61c4878aSAndroid Build Coastguard Worker 
43*61c4878aSAndroid Build Coastguard Worker   // Post any async tasks that should run. These will execute after calling
44*61c4878aSAndroid Build Coastguard Worker   // pw::SystemStart.
45*61c4878aSAndroid Build Coastguard Worker   pw::System().dispatcher().Post(my_task);
46*61c4878aSAndroid Build Coastguard Worker 
47*61c4878aSAndroid Build Coastguard Worker   // As needed, start threads to run user code. Or, register a task to start
48*61c4878aSAndroid Build Coastguard Worker   // threads after pw::SystemStart.
49*61c4878aSAndroid Build Coastguard Worker 
50*61c4878aSAndroid Build Coastguard Worker   // When ready, start running the pw::System threads and dispatcher. This
51*61c4878aSAndroid Build Coastguard Worker   // function call never returns.
52*61c4878aSAndroid Build Coastguard Worker   pw::SystemStart(channel.channel());
53*61c4878aSAndroid Build Coastguard Worker 
54*61c4878aSAndroid Build Coastguard Worker   return 0;
55*61c4878aSAndroid Build Coastguard Worker }
56*61c4878aSAndroid Build Coastguard Worker // DOCSTAG: [pw_system-async-example-main]
57*61c4878aSAndroid Build Coastguard Worker 
TEST(PwSystem,ReferToExampleMain)58*61c4878aSAndroid Build Coastguard Worker TEST(PwSystem, ReferToExampleMain) {
59*61c4878aSAndroid Build Coastguard Worker   if (false) {
60*61c4878aSAndroid Build Coastguard Worker     main();
61*61c4878aSAndroid Build Coastguard Worker   }
62*61c4878aSAndroid Build Coastguard Worker }
63*61c4878aSAndroid Build Coastguard Worker 
64*61c4878aSAndroid Build Coastguard Worker }  // namespace
65