pw_spi: Spelling error fixes to docs and comments
Only spelling error fixes in the docs and code comments. No
code changes at all.
Change-Id: Ibb1a14b41d216e229d7cabfe7aacb95164184f1d
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/110470
Commit-Queue: Chris Mumford <cmumford@google.com>
Reviewed-by: Armando Montanez <amontanez@google.com>
diff --git a/pw_spi/docs.rst b/pw_spi/docs.rst
index 1fb8cc9..ed9936b 100644
--- a/pw_spi/docs.rst
+++ b/pw_spi/docs.rst
@@ -144,7 +144,7 @@
.. Note:
- Throughtout ``pw_spi``, the terms "controller" and "peripheral" are used to
+ Throughout ``pw_spi``, the terms "controller" and "peripheral" are used to
describe the two roles SPI devices can implement. These terms correspond
to the "master" and "slave" roles described in legacy documentation
related to the SPI protocol.
@@ -159,7 +159,7 @@
.. cpp:function:: Status Configure(const Config& config)
- Configure the SPI bus to coummunicate using a specific set of properties,
+ Configure the SPI bus to communicate using a specific set of properties,
including the clock polarity, clock phase, bit-order, and bits-per-word.
Returns OkStatus() on success, and implementation-specific values on
@@ -204,7 +204,7 @@
SetActive sets the state of the chip-select signal to the value
represented by the `active` parameter. Passing a value of `true` will
- activate the chip-select signal, and `false` will deactive the
+ activate the chip-select signal, and `false` will deactivate the
chip-select signal.
Returns OkStatus() on success, and implementation-specific values on
@@ -227,13 +227,13 @@
pw::spi::Device
---------------
This is primary object used by a client to interact with a target SPI device.
-It provides a wrapper for an injected ``pw::spi::Initator`` object, using
+It provides a wrapper for an injected ``pw::spi::Initiator`` object, using
its methods to configure the bus and perform individual SPI transfers. The
injected ``pw::spi::ChipSelector`` object is used internally to activate and
de-actviate the device on-demand from within the data transfer methods.
The ``Read()``/``Write()``/``WriteRead()`` methods provide support for
-performing inidividual transfers: ``Read()`` and ``Write()`` perform
+performing individual transfers: ``Read()`` and ``Write()`` perform
half-duplex operations, where ``WriteRead()`` provides support for
full-duplex transfers.
@@ -255,7 +255,7 @@
Synchronously read data from the SPI peripheral until the provided
`read_buffer` is full.
- This call will configure the bus and activate/deactive chip select
+ This call will configure the bus and activate/deactivate chip select
for the transfer
Note: This call will block in the event that other clients are currently
@@ -267,7 +267,7 @@
.. cpp:function:: Status Write(ConstByteSpan write_buffer)
Synchronously write the contents of `write_buffer` to the SPI peripheral.
- This call will configure the bus and activate/deactive chip select
+ This call will configure the bus and activate/deactivate chip select
for the transfer
Note: This call will block in the event that other clients are currently
@@ -285,7 +285,7 @@
additional input bytes are discarded. In the event the write buffer is
smaller than the read buffer (or zero size), the output is padded with
0-bits for the remainder of the transfer.
- This call will configure the bus and activate/deactive chip select
+ This call will configure the bus and activate/deactivate chip select
for the transfer
Note: This call will block in the event that other clients are currently
@@ -301,7 +301,7 @@
underlying SPI bus (Initiator) for the object's duration. The `behavior`
parameter provides a means for a client to select how the chip-select
signal will be applied on Read/Write/WriteRead calls taking place with
- the Transaction object. A value of `kPerWriteRead` will activate/deactive
+ the Transaction object. A value of `kPerWriteRead` will activate/deactivate
chip-select on each operation, while `kPerTransaction` will hold the
chip-select active for the duration of the Transaction object.
diff --git a/pw_spi/public/pw_spi/chip_selector.h b/pw_spi/public/pw_spi/chip_selector.h
index 4792623..3290f50 100644
--- a/pw_spi/public/pw_spi/chip_selector.h
+++ b/pw_spi/public/pw_spi/chip_selector.h
@@ -37,7 +37,7 @@
// SetActive sets the state of the chip-select signal to the value represented
// by the `active` parameter. Passing a value of `true` will activate the
- // chip-select signal, and `false` will deactive the chip-select signal.
+ // chip-select signal, and `false` will deactivate the chip-select signal.
// Returns OkStatus() on success, and implementation-specific values on
// failure.
virtual Status SetActive(bool active) = 0;
diff --git a/pw_spi/public/pw_spi/device.h b/pw_spi/public/pw_spi/device.h
index 3701155..16095f1 100644
--- a/pw_spi/public/pw_spi/device.h
+++ b/pw_spi/public/pw_spi/device.h
@@ -41,7 +41,7 @@
// Synchronously read data from the SPI peripheral until the provided
// `read_buffer` is full.
- // This call will configure the bus and activate/deactive chip select
+ // This call will configure the bus and activate/deactivate chip select
// for the transfer
//
// Note: This call will block in the event that other clients are currently
@@ -51,7 +51,7 @@
Status Read(ByteSpan read_buffer) { return WriteRead({}, read_buffer); }
// Synchronously write the contents of `write_buffer` to the SPI peripheral.
- // This call will configure the bus and activate/deactive chip select
+ // This call will configure the bus and activate/deactivate chip select
// for the transfer
//
// Note: This call will block in the event that other clients are currently
@@ -69,7 +69,7 @@
// additional input bytes are discarded. In the event the write buffer is
// smaller than the read buffer (or zero size), the output is padded with
// 0-bits for the remainder of the transfer.
- // This call will configure the bus and activate/deactive chip select
+ // This call will configure the bus and activate/deactivate chip select
// for the transfer
//
// Note: This call will block in the event that other clients
@@ -192,7 +192,7 @@
// underlying SPI bus (Initiator) for the object's duration. The `behavior`
// parameter provides a means for a client to select how the chip-select
// signal will be applied on Read/Write/WriteRead calls taking place with the
- // Transaction object. A value of `kPerWriteRead` will activate/deactive
+ // Transaction object. A value of `kPerWriteRead` will activate/deactivate
// chip-select on each operation, while `kPerTransaction` will hold the
// chip-select active for the duration of the Transaction object.
Transaction StartTransaction(ChipSelectBehavior behavior) {
diff --git a/pw_spi/public/pw_spi/initiator.h b/pw_spi/public/pw_spi/initiator.h
index cc826c2..a750b03 100644
--- a/pw_spi/public/pw_spi/initiator.h
+++ b/pw_spi/public/pw_spi/initiator.h
@@ -71,7 +71,7 @@
static_assert(sizeof(Config) == sizeof(uint32_t),
"Ensure that the config struct fits in 32-bits");
-// The Inititor class provides an abstract interface used to configure and
+// The Initiator class provides an abstract interface used to configure and
// transmit data using a SPI bus.
class Initiator {
public:
@@ -79,7 +79,7 @@
// Configure the SPI bus to communicate with peripherals using a given set of
// properties, including the clock polarity, clock phase, bit-order, and
- // bits-per-wrod.
+ // bits-per-word.
// Returns OkStatus() on success, and implementation-specific values on
// failure.
virtual Status Configure(const Config& config) = 0;