DataFlashInlines.h

/**************************************************************************//**
 * @file DataFlashInlines.h
 * @brief File containing definitions for inline methods and functions for the
 * Atmel DataFlash Arduino library.
 *
 * @par Copyright: 
 * - Copyright (C) 2010-2011 by Vincent Cruz.
 * - Copyright (C) 2011 by Volker Kuhlmann. @n
 * All rights reserved.
 *
 * @authors
 * - Vincent Cruz @n
 *   cruz.vincent@gmail.com
 * - Volker Kuhlmann @n
 *   http://volker.top.geek.nz/contact.html
 *
 * @par Description:
 * Please refer to @ref DataFlash.cpp for more informations.
 *
 * @par History:
 * - Version 1.x, 2010-2011.
 * - Version 2.0, 30 Aug 2011.
 * - Version 2.2, 29 Dec 2011.
 *
 * @par Licence: GPLv3
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version. @n
 * @n
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details. @n
 * @n
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *****************************************************************************/
 
/**
 * @addtogroup AT45DBxxxD
 * @{
 **/
 
/**
 * Enable device with chipselect.
 **/
inline void DataFlash::enable()
{
    digitalWrite(m_chipSelectPin, LOW);
}

/**
 * Disable device with chipselect.
 **/
inline void DataFlash::disable()
{
    digitalWrite(m_chipSelectPin, HIGH);
}

/** Get chip Select (CS) pin **/
inline int8_t DataFlash::chipSelectPin  () const
{
    return m_chipSelectPin;
}

/** Get reset (RESET) pin **/
inline int8_t DataFlash::resetPin       () const
{
    return m_resetPin;
}

/** Get write protect (WP) pin **/
inline int8_t DataFlash::writeProtectPin() const
{
    return m_writeProtectPin;
}

/**
 * Compute page address high byte.
 */
inline uint8_t DataFlash::pageToHiU8(uint16_t page) const
{
    return page >> (16 - m_bufferSize);
}

/**
 * Compute page address low byte.
 */
inline uint8_t DataFlash::pageToLoU8(uint16_t page) const
{
    return page << (m_bufferSize  - 8);
}

/**
 * Same as waitUntilReady
 * @todo This method will be removed.
 **/
inline void DataFlash::endAndWait()
{
    /* Wait for the end of the previous operation. */
    waitUntilReady();
}

/** @} **/