2.3-InternetRadio/nutos/nut/dev/at24c.c

/*
 * Copyright (C) 2006 by egnite Software GmbH. All rights reserved.
 * Copyright (C) 2008 by egnite GmbH. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holders nor the names of
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * For additional information see http://www.ethernut.de/
 *
 */


#include <cfg/os.h>
#include <cfg/eeprom.h>

#include <sys/timer.h>
#include <sys/event.h>

#include <stdlib.h>

#include <dev/twif.h>
#include <dev/at24c.h>

//#define AT24C_AT91

//#define AT24C_DEBUG

#ifdef AT24C_DEBUG
#include <stdio.h>
#endif

/*!
 * \brief Helper routine to write to EEPROM with ACK-Polling support
 *
 * \param at24cs Device descriptor.
 * \param buffer Buffer to transfer into EEPROM.
 * \param len    Number of bytes to write.
 * \param addr   Address in EEPROM to place data.
 *
 * \return -1 in case of an error, -2 in case of timeout, else number of bytes written.
 */
static int lld_at24_write( struct at24c *at24cs, uint8_t *buffer, uint16_t len, uint16_t addr)
{
    uint8_t retry = at24cs->Timeout;
//  int tme;
    int rc;

#ifdef AT24C_DEBUG
        printf("MRW %u\n", len);
#endif

    do {
        /* Successfull write returns with number of bytes transmitted */
        rc = TwMasterRegWrite( at24cs->SlaveAddress, addr, at24cs->IAddrW, buffer, len, at24cs->Timeout);
#ifdef AT24C_DEBUG
        printf(" rc:%d re:%u\n", rc, retry);
#endif
        if( rc > 0)
            return rc;

        /* there was an error */
//      tme = TwMasterError();
#if 0
        if( tme == TWERR_OK)
            return 0;
#endif
//      if( tme & TWERR_SLA_NACK) {
            /* slave might be busy so we retry (ACK-Polling) */
            --retry;
            NutSleep(1);
//      }
//      else {
            /* it was something else than a NACK */
//          return -1;
//      }
    }
    while( retry);

    return -2;  // we get here if we ran out of delays for ACK of slave address
}

/*!
 * \brief Helper routine to read from EEPROM with ACK-Polling support
 *
 * \param at24cs Device descriptor.
 * \param buffer Buffer to transfer to from EEPROM.
 * \param len    Number of bytes to read.
 * \param addr   Address in EEPROM to read data from.
 *
 * \return -1 in case of an error, -2 in case of timeout else number of bytes read.
 */
static int lld_at24_read( struct at24c *at24cs, uint8_t *buffer, uint16_t len, uint16_t addr)
{
    uint8_t retry = at24cs->Timeout;
    uint32_t wtmo = len*retry/at24cs->PageSize;
//  int tme;
    int rc;

#ifdef AT24C_DEBUG
        printf("MRD %u\n", len);
#endif

    do {
        /* Successfull read returns with number of bytes received */
        rc = TwMasterRegRead( at24cs->SlaveAddress, addr, at24cs->IAddrW, buffer, len, wtmo);
        if( rc > 0)
            return rc;

//      tme = TwMasterError();
#ifdef AT24C_DEBUG
        printf(" rc:%d re:%u\n", rc, retry);
#endif
//        if( tme == TWERR_OK)
//            return 0;

        /* there was an error */
//      if( tme == TWERR_SLA_NACK) {
            --retry;

            NutSleep(1);
//      }
//        else
//            return -2;

    } while( retry);

    return -1;
}

/*!
 * \brief Read data from EEPROM with ACK-Polling support
 *
 * \param at24cs Device descriptor.
 * \param buffer Buffer to transfer to from EEPROM.
 * \param len    Number of bytes to read.
 * \param addr   Address in EEPROM where to read from.
 *
 * \return 0 on success or -1 in case of an error.
 */
/****************************************************************************/
int At24cRead( struct at24c *at24cs, uint8_t *buffer, uint16_t len, uint16_t addr )
/****************************************************************************/
{
    int rc = 0;

    /* Check if EEPROM is blocked by previous operation */
    rc = NutEventWait( &at24cs->ee_mutex, at24cs->Timeout*(len/at24cs->PageSize));
    if( rc) return rc;

#ifdef AT24C_BLOCK_ADDR
    if( at24cs->BlInSla) {
        /* Or blockk address into chip address */
        at24cs->SlaveAddress |= (uint8_t)((addr>>8)&0x7);
        addr &= 0xFF;
    }
#endif
#ifdef AT24C_DEBUG
    printf(" sa:%x da:%x l:%u\n", at24cs->SlaveAddress, addr, len);
#endif
    /* No, on read we definately do not have to wait for internal programming finished! */
    rc = lld_at24_read( at24cs, buffer, len, addr);

#ifdef AT24C_BLOCK_ADDR
    if( at24cs->BlInSla) {
        /* Reset address to chip without block */
        at24cs->SlaveAddress &= ~0x7;
    }
#endif

    NutEventPost( &at24cs->ee_mutex);
    return (rc >= 0) ? 0 : -1;
}

/*!
 * \brief Write data into eeprom memory.
 *
 * \param at24cs Device descriptor.
 * \param buffer Buffer to transfer to EEPROM.
 * \param len    Number of bytes to write.
 * \param addr   Address in EEPROM to place data.
 *
 * \return 0 on success or -1 in case of an error.
 */
/****************************************************************************/
int At24cWrite( struct at24c *at24cs, uint8_t *buffer, uint16_t len, uint16_t addr)
/****************************************************************************/
{
    int rc = 0;
    uint8_t *ptr = buffer;
    uint32_t bulk;
    uint32_t wl = 0;

#ifdef AT24C_BLOCK_ADDR
    if( at24cs->BlInSla) {
        /* Or blockk address into chip address */
        at24cs->SlaveAddress |= (uint8_t)((addr>>8)&0x7);
        addr &= 0xff;
    }
#endif
#ifdef AT24C_DEBUG
    printf(" sa:%x da:%x l:%u\n", at24cs->SlaveAddress, addr, len);
#endif

    /* Check if EEPROM is blocked by previous operation */
    rc = NutEventWait( &at24cs->ee_mutex, at24cs->Timeout*(len/at24cs->PageSize));
    if( rc) return rc;

    /* get first bulk of data till page end */
    while( len>0)
    {
        bulk = at24cs->PageSize-(addr%at24cs->PageSize);
        if( bulk > len) bulk = len;
        rc = lld_at24_write( at24cs, ptr, bulk, addr );
        if (rc>=0) wl+=rc; else break;
        ptr+=bulk; addr+=bulk; len-=bulk;
    }
#ifdef AT24C_BLOCK_ADDR
    if( at24cs->BlInSla) {
        /* Reset address to chip without block */
        at24cs->SlaveAddress &= ~0x7;
    }
#endif
    if (rc>0) rc = wl;
    NutEventPost( &at24cs->ee_mutex);
    return rc;
}