AFBoard Class Reference
The board abstraction class of the Audio Framework. More...
#include <AFBoard.h>
Public Member Functions | |
| AFBoard (AFCore *core) | |
| Constructor for AFBoard. | |
| virtual AF_STATUS | Init ()=0 |
| Abstracts the process of initializing a board. | |
| virtual VOID | Deinit ()=0 |
| Abstracts the process of deinitializing a board. | |
| virtual BOOL | InitPaths () |
| Matches the initialization paths between the board and the codec and eventually calls init on the codec. | |
| virtual AFI2SBusCaps * | GetI2SBusCaps () |
| Abstracts the process of retrieving the capabilities of the board. | |
| virtual AFPath * | GetIOPath () |
| Abstracts the process of retrieving the paths supported by the board. | |
| virtual FLOAT | GetSysClk () |
| Method to get the system clock frequency (in Hz) of the CPU or the board. | |
| virtual | ~AFBoard () |
| Empty destructor for AFBoard. | |
Protected Attributes | |
| AFCore * | core |
| AFI2SBusCaps | i2sBusCaps |
| AFPath * | ioPath |
| FLOAT | sysClk |
Detailed Description
The board abstraction class of the Audio Framework.
Definition at line 57 of file AFBoard.h.
Constructor & Destructor Documentation
| AFBoard::AFBoard | ( | AFCore * | core | ) | [inline] |
| virtual AFBoard::~AFBoard | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual VOID AFBoard::Deinit | ( | ) | [pure virtual] |
Abstracts the process of deinitializing a board.
A derived class will provide the deinitialization sequence for a particular board by overriding this member function.
| virtual AFI2SBusCaps* AFBoard::GetI2SBusCaps | ( | ) | [inline, virtual] |
Abstracts the process of retrieving the capabilities of the board.
- Returns:
- A pointer to AFI2SBusCaps.
| virtual AFPath* AFBoard::GetIOPath | ( | ) | [inline, virtual] |
| FLOAT AFBoard::GetSysClk | ( | ) | [virtual] |
Method to get the system clock frequency (in Hz) of the CPU or the board.
The value returned by this method is usually fed to a codec working in a slave mode to derive the other clocks required for I2S (BIT_CLK and LR_CLK).
- Returns:
- System clock frequency (in Hz).
Definition at line 39 of file AFBoard.cpp.
| virtual AF_STATUS AFBoard::Init | ( | ) | [pure virtual] |
Abstracts the process of initializing a board.
A derived class will provide the initialization sequence for a particular board by overriding this member function.
- Returns:
- AFS_SUCCESS on success. Check for failure using the AF_FAILURE macro in AFMessages.h.
| BOOL AFBoard::InitPaths | ( | ) | [virtual] |
Matches the initialization paths between the board and the codec and eventually calls init on the codec.
- Returns:
- TRUE on success, otherwise FALSE.
Definition at line 49 of file AFBoard.cpp.
Member Data Documentation
AFCore* AFBoard::core [protected] |
AFI2SBusCaps AFBoard::i2sBusCaps [protected] |
AFPath* AFBoard::ioPath [protected] |
FLOAT AFBoard::sysClk [protected] |
The documentation for this class was generated from the following files:
- C:/AudioFramework/Boards/AFBoard.h
- C:/AudioFramework/Boards/AFBoard.cpp
