ClearCore Library
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Public Attributes
ClearCore::StatusManager::StatusRegister Union Reference

Detailed Description

The ClearCore status register.

#include <StatusManager.h>

Public Member Functions

 StatusRegister ()
 
 StatusRegister (uint32_t val)
 
 operator bool () const
 

Public Attributes

uint32_t reg
 
struct { 
 
   uint32_t   VSupplyOverVoltage: 1 
 
   uint32_t   VSupplyUnderVoltage: 1 
 
   uint32_t   HBridgeOverloaded: 1 
 
   uint32_t   HBridgeReset: 1 
 
   uint32_t   Overloaded5V: 1 
 
   uint32_t   OutputOverloaded: 1 
 
   uint32_t   CcioOverloaded: 1 
 
   uint32_t   CcioLinkBroken: 1 
 
   uint32_t   AdcTimeout: 1 
 
   uint32_t   EthernetDisconnect: 1 
 
   uint32_t   EthernetRemoteFault: 1 
 
   uint32_t   EthernetPhyInitFailed: 1 
 
   uint32_t   SdCardError: 1 
 
   uint32_t   NvmDesync: 1 
 
bit 
 

Constructor & Destructor Documentation

◆ StatusRegister() [1/2]

ClearCore::StatusManager::StatusRegister::StatusRegister ( )
inline

Status Register default constructor

◆ StatusRegister() [2/2]

ClearCore::StatusManager::StatusRegister::StatusRegister ( uint32_t  val)
inline

Status Register constructor with initial value

Member Function Documentation

◆ operator bool()

ClearCore::StatusManager::StatusRegister::operator bool ( ) const
inline

Interpret the StatusRegister as a boolean by reporting whether any bits are set.

Member Data Documentation

◆ AdcTimeout

uint32_t ClearCore::StatusManager::StatusRegister::AdcTimeout

A conversion in the analog-to-digital converter has timed out.

◆ [struct]

struct { ... } ClearCore::StatusManager::StatusRegister::bit

◆ CcioLinkBroken

uint32_t ClearCore::StatusManager::StatusRegister::CcioLinkBroken

An established CCIO-8 link has gone offline.

◆ CcioOverloaded

uint32_t ClearCore::StatusManager::StatusRegister::CcioOverloaded

An output is currently overloaded on an attached CCIO-8 board (driven TRUE but being pulled FALSE).

◆ EthernetDisconnect

uint32_t ClearCore::StatusManager::StatusRegister::EthernetDisconnect

The Ethernet cable is unplugged.

◆ EthernetPhyInitFailed

uint32_t ClearCore::StatusManager::StatusRegister::EthernetPhyInitFailed

Ethernet initialization was attempted but failed.

◆ EthernetRemoteFault

uint32_t ClearCore::StatusManager::StatusRegister::EthernetRemoteFault

A remote Ethernet error has occurred.

◆ HBridgeOverloaded

uint32_t ClearCore::StatusManager::StatusRegister::HBridgeOverloaded

The H-Bridge chip on connectors IO-4 and IO-5 has experienced an overload condition.

Examples
DigitalIOExamples/WriteHBridgeOutput/WriteHBridgeOutput.cpp, and WriteHBridgeOutput.cpp.

◆ HBridgeReset

uint32_t ClearCore::StatusManager::StatusRegister::HBridgeReset

The H-Bridge chip on connectors IO-4 and IO-5 is currently undergoing a hardware reset.

◆ NvmDesync

uint32_t ClearCore::StatusManager::StatusRegister::NvmDesync

The last NVM write has not yet synchronized or was unable to synchronize.

◆ OutputOverloaded

uint32_t ClearCore::StatusManager::StatusRegister::OutputOverloaded

An output is currently overloaded on the ClearCore board (driven TRUE but being pulled FALSE).

◆ Overloaded5V

uint32_t ClearCore::StatusManager::StatusRegister::Overloaded5V

The 5V off-board supply has gone below 4V, outside of the range of normal operating conditions (nominally 5V).

◆ reg

uint32_t ClearCore::StatusManager::StatusRegister::reg

Broad access to the whole register

◆ SdCardError

uint32_t ClearCore::StatusManager::StatusRegister::SdCardError

The SD card is currently in a hardware fault state.

◆ VSupplyOverVoltage

uint32_t ClearCore::StatusManager::StatusRegister::VSupplyOverVoltage

Supply voltage has exceeded 29V, outside of the range of normal operating conditions (nominally 24 V).

◆ VSupplyUnderVoltage

uint32_t ClearCore::StatusManager::StatusRegister::VSupplyUnderVoltage

Supply voltage has gone below 10V, outside of the range of normal operating conditions (nominally 24V).


The documentation for this union was generated from the following file: