C/C++ API Reference
Loading...
Searching...
No Matches
initiator.h
1// Copyright 2025 The Pigweed Authors
2//
3// Licensed under the Apache License, Version 2.0 (the "License"); you may not
4// use this file except in compliance with the License. You may obtain a copy of
5// the License at
6//
7// https://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12// License for the specific language governing permissions and limitations under
13// the License.
14#pragma once
15
16#include <zephyr/device.h>
17
18#include "pw_i2c/initiator.h"
19#include "pw_sync/lock_annotations.h"
20#include "pw_sync/mutex.h"
21
22namespace pw::i2c {
23
24class ZephyrInitiator final : public Initiator {
25 public:
26 ZephyrInitiator(const struct device* dev)
27 : Initiator(Initiator::Feature::kStandard), dev_(dev) {}
28
29 private:
30 Status DoWriteReadFor(Address device_address,
31 ConstByteSpan tx_buffer,
32 ByteSpan rx_buffer,
33 chrono::SystemClock::duration timeout) override
34 PW_LOCKS_EXCLUDED(mutex_);
35
36 sync::Mutex mutex_;
37 const struct device* dev_ PW_GUARDED_BY(mutex_);
38};
39} // namespace pw::i2c
Definition: status.h:120
Definition: address.h:42
The common, base driver interface for initiating thread-safe transactions with devices on an I2C bus....
Definition: initiator.h:52
Definition: initiator.h:24
Definition: mutex.h:40
std::chrono::duration< rep, period > duration
Alias for durations representable with this clock.
Definition: system_clock.h:90
constexpr Initiator()
Definition: initiator.h:71
#define PW_GUARDED_BY(x)
Definition: lock_annotations.h:60
#define PW_LOCKS_EXCLUDED(...)
Definition: lock_annotations.h:176
Cross-platform I2C library.
Definition: address.h:19