FreeNOS
Public Types | Public Member Functions | Private Types | Private Attributes | Static Private Attributes
Broadcom2836 Class Reference
lib » libarch » Broadcom

Broadcom 2836 device specific I/O configuration. More...

#include <Broadcom2836.h>

Public Types

enum  Timer { PhysicalTimer1 , NonSecurePhysicalTimer }
 Hardware timers available in BCM 2836. More...
 
enum  Result {
  Success , NotFound , IOError , FrequencyError ,
  Success , NotFound , IOError , FrequencyError
}
 Result code. More...
 
enum  Timer { PhysicalTimer1 , NonSecurePhysicalTimer }
 Hardware timers available in BCM 2836. More...
 
enum  Result {
  Success , NotFound , IOError , FrequencyError ,
  Success , NotFound , IOError , FrequencyError
}
 Result code. More...
 

Public Member Functions

 Broadcom2836 (Size coreId)
 Constructor.
 
Result initialize ()
 Initialize the Controller.
 
Result setCoreTimerIrq (Timer timer, bool enable)
 Set Core Timer interrupt.
 
bool getCoreTimerIrqStatus (Timer timer) const
 Get core timer interrupt status.
 
 Broadcom2836 (Size coreId)
 Constructor.
 
Result initialize ()
 Initialize the Controller.
 
Result setCoreTimerIrq (Timer timer, bool enable)
 Set Core Timer interrupt.
 
bool getCoreTimerIrqStatus (Timer timer) const
 Get core timer interrupt status.
 

Private Types

enum  Registers {
  CorePrescalerRegister = 0x0008 , CoreTimerRegister = 0x0040 , CoreIrqRegister = 0x0060 , CoreSetMailboxRegister = 0x0080 ,
  CorePrescalerRegister = 0x0008 , CoreTimerRegister = 0x0040 , CoreIrqRegister = 0x0060 , CoreSetMailboxRegister = 0x0080
}
 Hardware registers. More...
 
enum  Registers {
  CorePrescalerRegister = 0x0008 , CoreTimerRegister = 0x0040 , CoreIrqRegister = 0x0060 , CoreSetMailboxRegister = 0x0080 ,
  CorePrescalerRegister = 0x0008 , CoreTimerRegister = 0x0040 , CoreIrqRegister = 0x0060 , CoreSetMailboxRegister = 0x0080
}
 Hardware registers. More...
 

Private Attributes

Size m_coreId
 Core identifier.
 
ARMIO m_io
 I/O instance.
 
ARM64IO m_io
 I/O instance.
 

Static Private Attributes

static const Address IOBase = 0x40000000
 Base address for the BCM2836 I/O configuration.
 

Detailed Description

Broadcom 2836 device specific I/O configuration.

Definition at line 38 of file Broadcom2836.h.

Member Enumeration Documentation

◆ Registers [1/2]

enum Broadcom2836::Registers
private

Hardware registers.

Enumerator
CorePrescalerRegister 
CoreTimerRegister 
CoreIrqRegister 
CoreSetMailboxRegister 
CorePrescalerRegister 
CoreTimerRegister 
CoreIrqRegister 
CoreSetMailboxRegister 

Definition at line 48 of file Broadcom2836.h.

◆ Registers [2/2]

enum Broadcom2836::Registers
private

Hardware registers.

Enumerator
CorePrescalerRegister 
CoreTimerRegister 
CoreIrqRegister 
CoreSetMailboxRegister 
CorePrescalerRegister 
CoreTimerRegister 
CoreIrqRegister 
CoreSetMailboxRegister 

Definition at line 49 of file Broadcom2836.h.

◆ Result [1/2]

enum Broadcom2836::Result

Result code.

Enumerator
Success 
NotFound 
IOError 
FrequencyError 
Success 
NotFound 
IOError 
FrequencyError 

Definition at line 69 of file Broadcom2836.h.

◆ Result [2/2]

enum Broadcom2836::Result

Result code.

Enumerator
Success 
NotFound 
IOError 
FrequencyError 
Success 
NotFound 
IOError 
FrequencyError 

Definition at line 70 of file Broadcom2836.h.

◆ Timer [1/2]

enum Broadcom2836::Timer

Hardware timers available in BCM 2836.

Enumerator
PhysicalTimer1 
NonSecurePhysicalTimer 

Definition at line 61 of file Broadcom2836.h.

◆ Timer [2/2]

enum Broadcom2836::Timer

Hardware timers available in BCM 2836.

Enumerator
PhysicalTimer1 
NonSecurePhysicalTimer 

Definition at line 62 of file Broadcom2836.h.

Constructor & Destructor Documentation

◆ Broadcom2836() [1/2]

Broadcom2836::Broadcom2836 ( Size  coreId)

Constructor.

Definition at line 20 of file Broadcom2836.cpp.

References IOBase, m_io, and IO::setBase().

◆ Broadcom2836() [2/2]

Broadcom2836::Broadcom2836 ( Size  coreId)

Constructor.

Member Function Documentation

◆ getCoreTimerIrqStatus() [1/2]

bool Broadcom2836::getCoreTimerIrqStatus ( Timer  timer) const

Get core timer interrupt status.

Parameters
timerTimer to check for interrupt status
Returns
True if timer IRQ is raised, false otherwise.

Referenced by RaspberryKernel::interrupt().

◆ getCoreTimerIrqStatus() [2/2]

bool Broadcom2836::getCoreTimerIrqStatus ( Timer  timer) const

Get core timer interrupt status.

Parameters
timerTimer to check for interrupt status
Returns
True if timer IRQ is raised, false otherwise.

◆ initialize() [1/2]

Broadcom2836::Result Broadcom2836::initialize ( )

Initialize the Controller.

Returns
Result code

Definition at line 26 of file Broadcom2836.cpp.

References Success.

◆ initialize() [2/2]

Result Broadcom2836::initialize ( )

Initialize the Controller.

Returns
Result code

◆ setCoreTimerIrq() [1/2]

Result Broadcom2836::setCoreTimerIrq ( Timer  timer,
bool  enable 
)

Set Core Timer interrupt.

Parameters
timerTimer to set
enableTrue to enable the timer interrupt
Returns
Result code

Referenced by RaspberryKernel::RaspberryKernel().

◆ setCoreTimerIrq() [2/2]

Result Broadcom2836::setCoreTimerIrq ( Timer  timer,
bool  enable 
)

Set Core Timer interrupt.

Parameters
timerTimer to set
enableTrue to enable the timer interrupt
Returns
Result code

Field Documentation

◆ IOBase

static const Address Broadcom2836::IOBase = 0x40000000
staticprivate

Base address for the BCM2836 I/O configuration.

Definition at line 43 of file Broadcom2836.h.

Referenced by Broadcom2836().

◆ m_coreId

Size Broadcom2836::m_coreId
private

Core identifier.

Definition at line 113 of file Broadcom2836.h.

◆ m_io [1/2]

ARMIO Broadcom2836::m_io
private

I/O instance.

Definition at line 116 of file Broadcom2836.h.

Referenced by Broadcom2836().

◆ m_io [2/2]

ARM64IO Broadcom2836::m_io
private

I/O instance.

Definition at line 117 of file Broadcom2836.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8