xref: /aosp_15_r20/external/pigweed/pw_spi/public/pw_spi/chip_selector_digital_out.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1 // Copyright 2023 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 
15 #pragma once
16 
17 #include "pw_digital_io/digital_io.h"
18 #include "pw_spi/chip_selector.h"
19 
20 namespace pw::spi {
21 
22 /// An implementation of pw::spi::ChipSelector that sets the state of a
23 /// pw_digital_io output when activated.
24 class DigitalOutChipSelector : public ChipSelector {
25  public:
DigitalOutChipSelector(pw::digital_io::DigitalOut & cs_pin)26   constexpr DigitalOutChipSelector(pw::digital_io::DigitalOut& cs_pin)
27       : cs_pin_(cs_pin) {}
28 
29   /// Set a pw::digital_io::DigitalOut state as a chip select signal.
30   ///
31   /// @param[active] true Set the DigitalOut to kActive
32   /// @param[active] false Set the DigitalOut to kInactive
SetActive(bool active)33   inline Status SetActive(bool active) override {
34     return cs_pin_.SetState(active ? pw::digital_io::State::kActive
35                                    : pw::digital_io::State::kInactive);
36   }
37 
38  private:
39   pw::digital_io::DigitalOut& cs_pin_;
40 };
41 
42 }  // namespace pw::spi
43