MityDSP Documentation Index

MityDSP::tcDspBankSelect Class Reference

The tcDspBankSelect class is used to change the currently selected Flash bank. More...

#include <core/DspBankSelect.h>

List of all members.

Public Member Functions

 tcDspBankSelect (void *apBaseAddr)
 This constructor is used to create an instance of tcDspBankSelect.
 ~tcDspBankSelect ()
 Default destructor.
bool setBank (int anBank)
 This routine sets the flash bank as commanded.
int getBank (void)
 This routine returns the last bank accessed.
int computeBank (void *apAddr)
 This routine computes the bank associated with the given flash offset address.

Detailed Description

The tcDspBankSelect class is used to change the currently selected Flash bank.

In general, it should be created and passed to tcDspFlash for use internally. Access to Bank 0 of the device is blocked unless BOOTLOADER is defined in order to prevent accidental erase of the bootloader code (which could leave the board in an unusable state).

See also:
tcDspBankSelect Page

Constructor & Destructor Documentation

tcDspBankSelect::tcDspBankSelect ( void *  apBaseAddr  ) 

This constructor is used to create an instance of tcDspBankSelect.

Parameters:
[in] apBaseAddr The base address of the flash device.
tcDspBankSelect::~tcDspBankSelect (  ) 

Default destructor.


Member Function Documentation

bool tcDspBankSelect::setBank ( int  anBank  ) 

This routine sets the flash bank as commanded.

Parameters:
[in] anBank The desired flash bank.
Returns:
True if successful, false otherwise.
int tcDspBankSelect::getBank ( void   ) 

This routine returns the last bank accessed.

Returns:
Last-known bank number.
int tcDspBankSelect::computeBank ( void *  apAddr  ) 

This routine computes the bank associated with the given flash offset address.

Parameters:
[in] apAddr The provided offset address in the flash device.
Returns:
Bank number corresponding to the provided offset address.

  
Generated on Fri Sep 23 16:33:47 2011 for MityDSP Core by  Doxygen Version 1.6.1
Copyright © 2009, Critical Link LLC, All rights reserved.