Device interface library for multiple platforms including Mbed.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

Embed: (wiki syntax)

« Back to documentation index

DS28E15_22_25::BlockProtection Class Reference

DS28E15_22_25::BlockProtection Class Reference

Represents the status of a memory protection block. More...

#include <DS28E15_22_25.hpp>

Public Member Functions

uint_least8_t statusByte () const
 Get the byte representation used by the device.
BlockProtectionsetStatusByte (uint_least8_t status)
 Set the byte representation used by the device.
int blockNum () const
 Get the Block Number which is indexed from zero.
MaximInterfaceDevices_EXPORT
BlockProtection
setBlockNum (int blockNum)
 Set the Block Number which is indexed from zero.
bool readProtection () const
 Get the Read Protection status.
MaximInterfaceDevices_EXPORT
BlockProtection
setReadProtection (bool readProtection)
 Set the Read Protection status.
bool writeProtection () const
 Get the Write Protection status.
MaximInterfaceDevices_EXPORT
BlockProtection
setWriteProtection (bool writeProtection)
 Set the Write Protection status.
bool eepromEmulation () const
 Get the EEPROM Emulation Mode status.
MaximInterfaceDevices_EXPORT
BlockProtection
setEepromEmulation (bool eepromEmulation)
 Set the EEPROM Emulation Mode status.
bool authProtection () const
 Get the Authentication Protection status.
MaximInterfaceDevices_EXPORT
BlockProtection
setAuthProtection (bool authProtection)
 Set the Authentication Protection status.
MaximInterfaceDevices_EXPORT bool noProtection () const
 Check if no protection options are enabled.

Detailed Description

Represents the status of a memory protection block.

Definition at line 468 of file DS28E15_22_25.hpp.


Member Function Documentation

bool authProtection (  ) const

Get the Authentication Protection status.

Returns:
True if Authentication Protection is enabled.

Definition at line 519 of file DS28E15_22_25.hpp.

int blockNum (  ) const

Get the Block Number which is indexed from zero.

Definition at line 482 of file DS28E15_22_25.hpp.

bool eepromEmulation (  ) const

Get the EEPROM Emulation Mode status.

Returns:
True if EEPROM Emulation Mode is enabled.

Definition at line 509 of file DS28E15_22_25.hpp.

bool noProtection (  ) const

Check if no protection options are enabled.

Returns:
True if no protection options are enabled.

Definition at line 135 of file DS28E15_22_25.cpp.

bool readProtection (  ) const

Get the Read Protection status.

Returns:
True if Read Protection is enabled.

Definition at line 489 of file DS28E15_22_25.hpp.

DS28E15_22_25::BlockProtection & setAuthProtection ( bool  authProtection )

Set the Authentication Protection status.

Definition at line 171 of file DS28E15_22_25.cpp.

DS28E15_22_25::BlockProtection & setBlockNum ( int  blockNum )

Set the Block Number which is indexed from zero.

Definition at line 129 of file DS28E15_22_25.cpp.

DS28E15_22_25::BlockProtection & setEepromEmulation ( bool  eepromEmulation )

Set the EEPROM Emulation Mode status.

Definition at line 161 of file DS28E15_22_25.cpp.

DS28E15_22_25::BlockProtection & setReadProtection ( bool  readProtection )

Set the Read Protection status.

Definition at line 141 of file DS28E15_22_25.cpp.

BlockProtection& setStatusByte ( uint_least8_t  status )

Set the byte representation used by the device.

Definition at line 476 of file DS28E15_22_25.hpp.

DS28E15_22_25::BlockProtection & setWriteProtection ( bool  writeProtection )

Set the Write Protection status.

Definition at line 151 of file DS28E15_22_25.cpp.

uint_least8_t statusByte (  ) const

Get the byte representation used by the device.

Definition at line 473 of file DS28E15_22_25.hpp.

bool writeProtection (  ) const

Get the Write Protection status.

Returns:
True if Write Protection is enabled.

Definition at line 499 of file DS28E15_22_25.hpp.