Public Types |
Public Member Functions |
Private Member Functions |
Private Attributes |
Static Private Attributes |
List of all members
distortos::devices::SpiEeprom Class Reference
#include "distortos/devices/memory/SpiEeprom.hpp"
Inheritance diagram for distortos::devices::SpiEeprom:
Collaboration diagram for distortos::devices::SpiEeprom:
Public Types | |
| enum | Type : uint8_t { Type::_128Bytes8BytesPerPage = 0 << sizeShift_ | 0 << pageSizeShift_, Type::_128Bytes16BytesPerPage = 0 << sizeShift_ | 1 << pageSizeShift_, Type::_256Bytes8BytesPerPage = 1 << sizeShift_ | 0 << pageSizeShift_, Type::_256Bytes16BytesPerPage = 1 << sizeShift_ | 1 << pageSizeShift_, Type::_512Bytes8BytesPerPage = 2 << sizeShift_ | 0 << pageSizeShift_, Type::_512Bytes16BytesPerPage = 2 << sizeShift_ | 1 << pageSizeShift_, Type::_1KBytes16BytesPerPage = 3 << sizeShift_ | 1 << pageSizeShift_, Type::_1KBytes32BytesPerPage = 3 << sizeShift_ | 2 << pageSizeShift_, Type::_2KBytes16BytesPerPage = 4 << sizeShift_ | 1 << pageSizeShift_, Type::_2KBytes32BytesPerPage = 4 << sizeShift_ | 2 << pageSizeShift_, Type::_4KBytes32BytesPerPage = 5 << sizeShift_ | 2 << pageSizeShift_, Type::_8KBytes32BytesPerPage = 6 << sizeShift_ | 2 << pageSizeShift_, Type::_8KBytes64BytesPerPage = 6 << sizeShift_ | 3 << pageSizeShift_, Type::_16KBytes64BytesPerPage = 7 << sizeShift_ | 3 << pageSizeShift_, Type::_32KBytes64BytesPerPage = 8 << sizeShift_ | 3 << pageSizeShift_, Type::_64KBytes128BytesPerPage = 9 << sizeShift_ | 4 << pageSizeShift_, Type::_128KBytes256BytesPerPage = 10 << sizeShift_ | 5 << pageSizeShift_, Type::_256KBytes256BytesPerPage = 11 << sizeShift_ | 5 << pageSizeShift_, Type::at25010 = _128Bytes8BytesPerPage, Type::at25020 = _256Bytes8BytesPerPage, Type::at25040 = _512Bytes8BytesPerPage, Type::at25080 = _1KBytes32BytesPerPage, Type::at25160 = _2KBytes32BytesPerPage, Type::at25320 = _4KBytes32BytesPerPage, Type::at25640 = _8KBytes32BytesPerPage, Type::at25128 = _16KBytes64BytesPerPage, Type::at25256 = _32KBytes64BytesPerPage, Type::at25512 = _64KBytes128BytesPerPage, Type::at25m01 = _128KBytes256BytesPerPage, Type::at25m02 = _256KBytes256BytesPerPage, Type::cat25010 = _128Bytes16BytesPerPage, Type::cat25020 = _256Bytes16BytesPerPage, Type::cat25040 = _512Bytes16BytesPerPage, Type::cat25080 = _1KBytes32BytesPerPage, Type::cat25160 = _2KBytes32BytesPerPage, Type::cat25320 = _4KBytes32BytesPerPage, Type::cat25640 = _8KBytes64BytesPerPage, Type::cat25128 = _16KBytes64BytesPerPage, Type::cat25256 = _32KBytes64BytesPerPage, Type::cat25512 = _64KBytes128BytesPerPage, Type::cat25m01 = _128KBytes256BytesPerPage, Type::cat25m02 = _256KBytes256BytesPerPage, Type::m95010 = _128Bytes16BytesPerPage, Type::m95020 = _256Bytes16BytesPerPage, Type::m95040 = _512Bytes16BytesPerPage, Type::m95080 = _1KBytes32BytesPerPage, Type::m95160 = _2KBytes32BytesPerPage, Type::m95320 = _4KBytes32BytesPerPage, Type::m95640 = _8KBytes32BytesPerPage, Type::m95128 = _16KBytes64BytesPerPage, Type::m95256 = _32KBytes64BytesPerPage, Type::m95512 = _64KBytes128BytesPerPage, Type::m95m01 = _128KBytes256BytesPerPage, Type::m95m02 = _256KBytes256BytesPerPage, Type::_25xx010 = _128Bytes16BytesPerPage, Type::_25xx020 = _256Bytes16BytesPerPage, Type::_25xx040 = _512Bytes16BytesPerPage, Type::_25xx080 = _1KBytes16BytesPerPage, Type::_25xx080a = _25xx080, Type::_25xx080b = _1KBytes32BytesPerPage, Type::_25xx080c = _25xx080, Type::_25xx080d = _25xx080b, Type::_25xx160 = _2KBytes16BytesPerPage, Type::_25xx160a = _25xx160, Type::_25xx160b = _2KBytes32BytesPerPage, Type::_25xx160c = _25xx160, Type::_25xx160d = _25xx160b, Type::_25xx320 = _4KBytes32BytesPerPage, Type::_25xx640 = _8KBytes32BytesPerPage, Type::_25xx128 = _16KBytes64BytesPerPage, Type::_25xx256 = _32KBytes64BytesPerPage, Type::_25xx512 = _64KBytes128BytesPerPage, Type::_25xx1024 = _128KBytes256BytesPerPage } |
| type of device - determines size and page size More... | |
Public Member Functions | |
| constexpr | SpiEeprom (SpiMaster &spiMaster, OutputPin &slaveSelectPin, const Type type, const bool mode3={}, const uint32_t clockFrequency=1000000) |
| SpiEeprom's constructor. More... | |
| ~SpiEeprom () override | |
| SpiEeprom's destructor. More... | |
| int | close () override |
| Closes SPI EEPROM. More... | |
| int | erase (uint64_t address, uint64_t size) override |
| Erases blocks on SPI EEPROM. More... | |
| size_t | getBlockSize () const override |
| uint64_t | getSize () const override |
| void | lock () override |
| Locks SPI EEPROM for exclusive use by current thread. More... | |
| int | open () override |
| Opens SPI EEPROM. More... | |
| int | read (uint64_t address, void *buffer, size_t size) override |
| Reads data from SPI EEPROM. More... | |
| int | synchronize () override |
| Synchronizes state of SPI EEPROM, ensuring all cached writes are finished. More... | |
| void | unlock () override |
| Unlocks SPI EEPROM which was previously locked by current thread. More... | |
| int | write (uint64_t address, const void *buffer, size_t size) override |
| Writes data to SPI EEPROM. More... | |
 Public Member Functions inherited from distortos::devices::BlockDevice | |
| virtual | ~BlockDevice ()=default |
| BlockDevice's destructor. More... | |
| BlockDevice (const BlockDevice &)=delete | |
| BlockDevice & | operator= (const BlockDevice &)=delete |
Private Member Functions | |
| int | eraseOrWrite (uint64_t address, const void *buffer, uint64_t size) |
| Implementation of erase() and write() More... | |
| std::pair< int, size_t > | eraseOrWritePage (uint32_t address, const void *buffer, size_t size) |
| Erases or writes single page. More... | |
| int | executeTransaction (SpiMasterTransfersRange transfersRange) const |
| Executes series of transfers as a single atomic transaction. More... | |
| size_t | getPageSize () const |
| std::pair< int, bool > | isWriteInProgress () |
| Checks whether any write operation is currently in progress. More... | |
| std::pair< int, uint8_t > | readStatusRegister () const |
| Reads value of status register of SPI EEPROM. More... | |
| int | waitWhileWriteInProgress () |
| Waits while any write operation is currently in progress. More... | |
| int | writeEnable () const |
| Enables writes in SPI EEPROM. More... | |
Private Attributes | |
| Mutex | mutex_ |
| mutex used to serialize access to this object More... | |
| uint32_t | clockFrequency_ |
| desired clock frequency of SPI EEPROM, Hz More... | |
| OutputPin & | slaveSelectPin_ |
| reference to slave select pin of this SPI EEPROM More... | |
| SpiMaster & | spiMaster_ |
| reference to SPI master to which this SPI EEPROM is connected More... | |
| SpiMode | mode_ |
| SPI mode used by SPI EEPROM. More... | |
| uint8_t | openCount_ |
| number of times this device was opened but not yet closed More... | |
| Type | type_ |
| type of SPI EEPROM More... | |
Static Private Attributes | |
| static constexpr size_t | pageSizeShift_ {0} |
| bit shift of field with page size encoded in device's type More... | |
| static constexpr size_t | pageSizeWidth_ {3} |
| bit width of field with page size encoded in device's type More... | |
| static constexpr size_t | pageSizeMask_ {((1 << pageSizeWidth_) - 1) << pageSizeShift_} |
| bit mask of field with page size encoded in device's type More... | |
| static constexpr size_t | sizeShift_ {pageSizeWidth_} |
| bit shift of field with size encoded in device's type More... | |
| static constexpr size_t | sizeWidth_ {8 - pageSizeWidth_} |
| bit width of field with size encoded in device's type More... | |
| static constexpr size_t | sizeMask_ {((1 << sizeWidth_) - 1) << sizeShift_} |
| bit mask of field with size encoded in device's type More... | |
Detailed Description
SpiEeprom class is a SPI EEPROM memory: Atmel AT25xxx, ON Semiconductor CAT25xxx, ST M95xxx, Microchip 25xxxxx or similar.
Member Enumeration Documentation
◆ Type
|
strong |
type of device - determines size and page size
Constructor & Destructor Documentation
◆ SpiEeprom()
|
inline |
SpiEeprom's constructor.
- Parameters
-
[in] spiMaster is a reference to SPI master to which this SPI EEPROM is connected [in] slaveSelectPin is a reference to slave select pin of this SPI EEPROM [in] type is the type of SPI EEPROM [in] mode3 selects whether SPI mode 0 - CPOL == 0, CPHA == 0 - (false) or SPI mode 3 - CPOL == 1, CPHA == 1 - (true) will be used, default - SPI mode 0 (false) [in] clockFrequency is the desired clock frequency of SPI EEPROM, Hz, default - 1 MHz
◆ ~SpiEeprom()
|
override |
SpiEeprom's destructor.
- Precondition
- Device is closed.
Member Function Documentation
◆ close()
|
overridevirtual |
Closes SPI EEPROM.
- Note
- Even if error code is returned, the device must not be used from the context which opened it (until it is successfully opened again).
- Warning
- This function must not be called from interrupt context!
- Precondition
- Device is opened.
- Returns
- 0 on success, error code otherwise
Implements distortos::devices::BlockDevice.
Here is the call graph for this function:
◆ erase()
|
overridevirtual |
Erases blocks on SPI EEPROM.
- Warning
- This function must not be called from interrupt context!
- Precondition
- Device is opened.
- address and size are valid.
- Selected range is within address space of device.
- Parameters
-
[in] address is the address of range that will be erased [in] size is the size of erased range, bytes
- Returns
- 0 on success, error code otherwise:
- error codes returned by eraseOrWrite();
Implements distortos::devices::BlockDevice.
Here is the call graph for this function:
◆ eraseOrWrite()
|
private |
Implementation of erase() and write()
- Precondition
- Device is opened.
- Selected range is within address space of device.
- Parameters
-
[in] address is the address of data that will be erased or written [in] buffer is the buffer with data that will be written, nullptr to erase [in] size is the size of erase ( buffer == nullptr) or size of buffer (buffer != nullptr), bytes
- Returns
- 0 on success, error code otherwise:
- error codes returned by eraseOrWritePage();
Here is the call graph for this function:
Here is the caller graph for this function:
◆ eraseOrWritePage()
|
private |
Erases or writes single page.
- Parameters
-
[in] address is the address of data that will be erased or written, must be valid! [in] buffer is the buffer with data that will be written, nullptr to erase [in] size is the size of erase ( buffer == nullptr) or size of buffer (buffer != nullptr), bytes
- Returns
- pair with return code (0 on success, error code otherwise) and number of erased/written bytes; error codes:
- error codes returned by executeTransaction();
- error codes returned by waitWhileWriteInProgress();
- error codes returned by writeEnable();
Here is the call graph for this function:
Here is the caller graph for this function:
◆ executeTransaction()
|
private |
Executes series of transfers as a single atomic transaction.
- Parameters
-
[in] transfersRange is the range of transfers that will be executed
- Returns
- 0 on success, error code otherwise:
- error codes returned by SpiMasterHandle::executeTransaction();
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getBlockSize()
|
overridevirtual |
- Returns
- block size, bytes
Implements distortos::devices::BlockDevice.
◆ getPageSize()
|
inlineprivate |
- Returns
- size of single page, bytes
Here is the caller graph for this function:
◆ getSize()
|
overridevirtual |
- Returns
- size of SPI EEPROM, bytes
Implements distortos::devices::BlockDevice.
Here is the caller graph for this function:
◆ isWriteInProgress()
|
private |
Checks whether any write operation is currently in progress.
- Returns
- pair with return code (0 on success, error code otherwise) and current status of device: false - device is idle, true - write operation is in progress; error codes:
- error codes returned by readStatusRegister();
Here is the call graph for this function:
Here is the caller graph for this function:
◆ lock()
|
overridevirtual |
Locks SPI EEPROM for exclusive use by current thread.
When the object is locked, any call to any member function from other thread will be blocked until the object is unlocked. Locking is optional, but may be useful when more than one transaction must be done atomically.
- Note
- Locks are recursive.
- Warning
- This function must not be called from interrupt context!
- Precondition
- The number of recursive locks of device is less than 65535.
- Postcondition
- Device is locked.
Implements distortos::devices::BlockDevice.
Here is the call graph for this function:
◆ open()
|
overridevirtual |
Opens SPI EEPROM.
- Warning
- This function must not be called from interrupt context!
- Precondition
- The number of times the device is opened is less than 255.
- Returns
- 0 on success, error code otherwise:
- error codes returned by SpiMasterHandle::open();
Implements distortos::devices::BlockDevice.
Here is the call graph for this function:
◆ read()
|
overridevirtual |
Reads data from SPI EEPROM.
- Warning
- This function must not be called from interrupt context!
- Precondition
- Device is opened.
- address and buffer and size are valid.
- Selected range is within address space of device.
- Parameters
-
[in] address is the address of data that will be read [out] buffer is the buffer into which the data will be read, must be valid [in] size is the size of buffer, bytes
- Returns
- 0 on success, error code otherwise:
- error codes returned by executeTransaction();
- error codes returned by waitWhileWriteInProgress();
Implements distortos::devices::BlockDevice.
Here is the call graph for this function:
◆ readStatusRegister()
|
private |
Reads value of status register of SPI EEPROM.
- Returns
- pair with return code (0 on success, error code otherwise) and value of status register of SPI EEPROM; error codes:
- error codes returned by executeTransaction();
Here is the call graph for this function:
Here is the caller graph for this function:
◆ synchronize()
|
overridevirtual |
Synchronizes state of SPI EEPROM, ensuring all cached writes are finished.
- Warning
- This function must not be called from interrupt context!
- Precondition
- Device is opened.
- Returns
- 0 on success, error code otherwise:
- error codes returned by waitWhileWriteInProgress();
Implements distortos::devices::BlockDevice.
Here is the call graph for this function:
◆ unlock()
|
overridevirtual |
Unlocks SPI EEPROM which was previously locked by current thread.
- Note
- Locks are recursive.
- Warning
- This function must not be called from interrupt context!
- Precondition
- This function is called by the thread that locked the device.
Implements distortos::devices::BlockDevice.
Here is the call graph for this function:
◆ waitWhileWriteInProgress()
|
private |
Waits while any write operation is currently in progress.
- Returns
- 0 on success, error code otherwise:
- error codes returned by isWriteInProgress();
- error codes returned by ThisThread::sleepFor();
Here is the call graph for this function:
Here is the caller graph for this function:
◆ write()
|
overridevirtual |
Writes data to SPI EEPROM.
- Warning
- This function must not be called from interrupt context!
- Precondition
- Device is opened.
- address and buffer and size are valid.
- Selected range is within address space of device.
- Parameters
-
[in] address is the address of data that will be written [in] buffer is the buffer with data that will be written, must be valid [in] size is the size of buffer, bytes
- Returns
- 0 on success, error code otherwise:
- error codes returned by eraseOrWrite();
Implements distortos::devices::BlockDevice.
Here is the call graph for this function:
◆ writeEnable()
|
private |
Enables writes in SPI EEPROM.
- Returns
- 0 on success, error code otherwise:
- error codes returned by executeTransaction();
Here is the call graph for this function:
Here is the caller graph for this function:
Member Data Documentation
◆ clockFrequency_
|
private |
desired clock frequency of SPI EEPROM, Hz
◆ mode_
|
private |
SPI mode used by SPI EEPROM.
◆ mutex_
|
private |
mutex used to serialize access to this object
◆ openCount_
|
private |
number of times this device was opened but not yet closed
◆ pageSizeMask_
|
staticprivate |
bit mask of field with page size encoded in device's type
◆ pageSizeShift_
|
staticprivate |
bit shift of field with page size encoded in device's type
◆ pageSizeWidth_
|
staticprivate |
bit width of field with page size encoded in device's type
◆ sizeMask_
|
staticprivate |
bit mask of field with size encoded in device's type
◆ sizeShift_
|
staticprivate |
bit shift of field with size encoded in device's type
◆ sizeWidth_
|
staticprivate |
bit width of field with size encoded in device's type
◆ slaveSelectPin_
|
private |
reference to slave select pin of this SPI EEPROM
◆ spiMaster_
|
private |
reference to SPI master to which this SPI EEPROM is connected
◆ type_
|
private |
type of SPI EEPROM
The documentation for this class was generated from the following files:
- include/distortos/devices/memory/SpiEeprom.hpp
- source/devices/memory/SpiEeprom.cpp
