fsm_sii.c

Go to the documentation of this file.

/******************************************************************************
 *
 *  $Id$
 *
 *  Copyright (C) 2006-2008  Florian Pose, Ingenieurgemeinschaft IgH
 *
 *  This file is part of the IgH EtherCAT Master.
 *
 *  The IgH EtherCAT Master is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License version 2, as
 *  published by the Free Software Foundation.
 *
 *  The IgH EtherCAT Master 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.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with the IgH EtherCAT Master; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 *  ---
 *
 *  The license mentioned above concerns the source code only. Using the
 *  EtherCAT technology and brand is only permitted in compliance with the
 *  industrial property and similar rights of Beckhoff Automation GmbH.
 *
 *****************************************************************************/

/*****************************************************************************/

#include "globals.h"
#include "mailbox.h"
#include "master.h"
#include "fsm_sii.h"

#define SII_LOAD_TIMEOUT 500

#define SII_TIMEOUT 20

#define SII_INHIBIT 5

//#define SII_DEBUG

/*****************************************************************************/

void ec_fsm_sii_state_start_reading(ec_fsm_sii_t *, ec_datagram_t *);
void ec_fsm_sii_state_read_check(ec_fsm_sii_t *, ec_datagram_t *);
void ec_fsm_sii_state_read_fetch(ec_fsm_sii_t *, ec_datagram_t *);
void ec_fsm_sii_state_start_writing(ec_fsm_sii_t *, ec_datagram_t *);
void ec_fsm_sii_state_write_check(ec_fsm_sii_t *, ec_datagram_t *);
void ec_fsm_sii_state_write_check2(ec_fsm_sii_t *, ec_datagram_t *);
void ec_fsm_sii_state_end(ec_fsm_sii_t *, ec_datagram_t *);
void ec_fsm_sii_state_error(ec_fsm_sii_t *, ec_datagram_t *);

/*****************************************************************************/

void ec_fsm_sii_init(ec_fsm_sii_t *fsm 
                     )
{
    fsm->state = NULL;
    fsm->datagram = NULL;
}

/*****************************************************************************/

void ec_fsm_sii_clear(ec_fsm_sii_t *fsm )
{
}

/*****************************************************************************/

void ec_fsm_sii_read(ec_fsm_sii_t *fsm, 
                     ec_slave_t *slave, 
                     uint16_t word_offset, 
                     ec_fsm_sii_addressing_t mode 
                     )
{
    fsm->state = ec_fsm_sii_state_start_reading;
    fsm->slave = slave;
    fsm->word_offset = word_offset;
    fsm->mode = mode;
}

/*****************************************************************************/

void ec_fsm_sii_write(ec_fsm_sii_t *fsm, 
                      ec_slave_t *slave, 
                      uint16_t word_offset, 
                      const uint16_t *value, 
                      ec_fsm_sii_addressing_t mode 
                      )
{
    fsm->state = ec_fsm_sii_state_start_writing;
    fsm->slave = slave;
    fsm->word_offset = word_offset;
    fsm->mode = mode;
    memcpy(fsm->value, value, 2);
}

/*****************************************************************************/

int ec_fsm_sii_exec(ec_fsm_sii_t *fsm, 
                    ec_datagram_t *datagram 
                    )
{
    if (fsm->state == ec_fsm_sii_state_end || fsm->state == ec_fsm_sii_state_error)
        return 0;
    if (fsm->datagram &&
            (fsm->datagram->state == EC_DATAGRAM_INIT ||
             fsm->datagram->state == EC_DATAGRAM_QUEUED ||
             fsm->datagram->state == EC_DATAGRAM_SENT)) {
        // datagram not received yet
        if (datagram != fsm->datagram)
            datagram->state = EC_DATAGRAM_INVALID;
        return 1;
    }

    fsm->state(fsm, datagram);

    if (fsm->state == ec_fsm_sii_state_end || fsm->state == ec_fsm_sii_state_error) {
        fsm->datagram = NULL;
        return 0;
    }

    fsm->datagram = datagram;
    return 1;
}

/*****************************************************************************/

int ec_fsm_sii_success(ec_fsm_sii_t *fsm )
{
    return fsm->state == ec_fsm_sii_state_end;
}

/******************************************************************************
 * datagram functions
 *****************************************************************************/

static void ec_fsm_sii_prepare_read(
        ec_fsm_sii_t *fsm, 
        ec_datagram_t *datagram 
        )
{
    // initiate read operation
    switch (fsm->mode) {
        case EC_FSM_SII_USE_INCREMENT_ADDRESS:
            ec_datagram_apwr(datagram, fsm->slave->ring_position, 0x502, 4);
            break;
        case EC_FSM_SII_USE_CONFIGURED_ADDRESS:
            ec_datagram_fpwr(datagram, fsm->slave->station_address, 0x502, 4);
            break;
    }

    EC_WRITE_U8 (datagram->data,     0x80); // two address octets
    EC_WRITE_U8 (datagram->data + 1, 0x01); // request read operation
    EC_WRITE_U16(datagram->data + 2, fsm->word_offset);
}

/*****************************************************************************/

static void ec_fsm_sii_prepare_read_check(
        ec_fsm_sii_t *fsm, 
        ec_datagram_t *datagram 
        )
{
    // issue check/fetch datagram
    switch (fsm->mode) {
        case EC_FSM_SII_USE_INCREMENT_ADDRESS:
            ec_datagram_aprd(datagram, fsm->slave->ring_position, 0x502, 10);
            break;
        case EC_FSM_SII_USE_CONFIGURED_ADDRESS:
            ec_datagram_fprd(datagram, fsm->slave->station_address, 0x502, 10);
            break;
    }

    ec_datagram_zero(datagram);
}

/*****************************************************************************/

static void ec_fsm_sii_prepare_write(
        ec_fsm_sii_t *fsm, 
        ec_datagram_t *datagram 
        )
{
    // initiate write operation
    ec_datagram_fpwr(datagram, fsm->slave->station_address, 0x502, 8);
    EC_WRITE_U8 (datagram->data,     0x81); /* two address octets
                                               + enable write access */
    EC_WRITE_U8 (datagram->data + 1, 0x02); // request write operation
    EC_WRITE_U16(datagram->data + 2, fsm->word_offset);
    memset(datagram->data + 4, 0x00, 2);
    memcpy(datagram->data + 6, fsm->value, 2);
}

/*****************************************************************************/

static void ec_fsm_sii_prepare_write_check(
        ec_fsm_sii_t *fsm, 
        ec_datagram_t *datagram 
        )
{
    // issue check datagram
    ec_datagram_fprd(datagram, fsm->slave->station_address, 0x502, 2);
    ec_datagram_zero(datagram);
}

/******************************************************************************
 * state functions
 *****************************************************************************/

void ec_fsm_sii_state_start_reading(
        ec_fsm_sii_t *fsm, 
        ec_datagram_t *datagram 
        )
{
    ec_fsm_sii_prepare_read(fsm, datagram);

#ifdef SII_DEBUG
    EC_SLAVE_DBG(fsm->slave, 0, "reading SII data, word %u:\n",
            fsm->word_offset);
    ec_print_data(datagram->data, 4);
#endif

    fsm->retries = EC_FSM_RETRIES;
    fsm->state = ec_fsm_sii_state_read_check;
}

/*****************************************************************************/

void ec_fsm_sii_state_read_check(
        ec_fsm_sii_t *fsm, 
        ec_datagram_t *datagram 
        )
{
    if (fsm->datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--) {
        ec_fsm_sii_prepare_read(fsm, datagram);
        return;
    }

    if (fsm->datagram->state != EC_DATAGRAM_RECEIVED) {
        fsm->state = ec_fsm_sii_state_error;
        EC_SLAVE_ERR(fsm->slave, "Failed to receive SII read datagram: ");
        ec_datagram_print_state(fsm->datagram);
        return;
    }

    if (fsm->datagram->working_counter != 1) {
        fsm->state = ec_fsm_sii_state_error;
        EC_SLAVE_ERR(fsm->slave, "Reception of SII read datagram failed: ");
        ec_datagram_print_wc_error(fsm->datagram);
        return;
    }

    fsm->jiffies_start = fsm->datagram->jiffies_sent;
    fsm->check_once_more = 1;
    fsm->eeprom_load_retry = 0;

    ec_fsm_sii_prepare_read_check(fsm, datagram);
    fsm->retries = EC_FSM_RETRIES;
    fsm->state = ec_fsm_sii_state_read_fetch;
}

/*****************************************************************************/

void ec_fsm_sii_state_read_fetch(
        ec_fsm_sii_t *fsm, 
        ec_datagram_t *datagram 
        )
{
    if (fsm->datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--) {
        ec_fsm_sii_prepare_read_check(fsm, datagram);
        return;
    }

    if (fsm->datagram->state != EC_DATAGRAM_RECEIVED) {
        fsm->state = ec_fsm_sii_state_error;
        EC_SLAVE_ERR(fsm->slave,
                "Failed to receive SII check/fetch datagram: ");
        ec_datagram_print_state(fsm->datagram);
        return;
    }

    if (fsm->datagram->working_counter != 1) {
        fsm->state = ec_fsm_sii_state_error;
        EC_SLAVE_ERR(fsm->slave,
                "Reception of SII check/fetch datagram failed: ");
        ec_datagram_print_wc_error(fsm->datagram);
        return;
    }

#ifdef SII_DEBUG
    EC_SLAVE_DBG(fsm->slave, 0, "checking SII read state:\n");
    ec_print_data(fsm->datagram->data, 10);
#endif

    if (EC_READ_U8(fsm->datagram->data + 1) & 0x20) {
        EC_SLAVE_ERR(fsm->slave, "Error on last command while"
                " reading from SII word 0x%04x.\n", fsm->word_offset);
        fsm->state = ec_fsm_sii_state_error;
        return;
    }

    // check "EEPROM Loading bit"
    if (EC_READ_U8(fsm->datagram->data + 1) & 0x10) { /* EEPROM not loaded */
        unsigned long diff_ms;
    
        if (fsm->eeprom_load_retry == 0) {
            fsm->eeprom_load_retry = 1;
            EC_SLAVE_WARN(fsm->slave,
                    "SII Read Error, EEPROM not loaded.  Retrying...\n");
        }

        // EEPROM still not loaded... timeout?
        // May be due to an EEPROM load error
        diff_ms =
            (fsm->datagram->jiffies_received - fsm->jiffies_start) * 1000 / HZ;
        if (diff_ms >= SII_LOAD_TIMEOUT) {
            if (fsm->check_once_more) {
                fsm->check_once_more = 0;
            } else {
                EC_SLAVE_ERR(fsm->slave, 
                        "SII Error: Timeout waiting for EEPROM to load.\n");
                fsm->state = ec_fsm_sii_state_error;
                return;
            }
        }

        // issue check/fetch datagram again
        ec_fsm_sii_prepare_read_check(fsm, datagram);
        fsm->retries = EC_FSM_RETRIES;
        return;
    } else if (fsm->eeprom_load_retry) {
        fsm->eeprom_load_retry = 0;
        EC_SLAVE_INFO(fsm->slave, "SII EEPROM loaded.  Continuing.\n");
        
        // start reading SII value again
        fsm->state = ec_fsm_sii_state_start_reading;
        return;
    }
    
    // check "busy bit"
    if (EC_READ_U8(fsm->datagram->data + 1) & 0x81) { /* busy bit or
                                                    read operation busy */
        // still busy... timeout?
        unsigned long diff_ms =
            (fsm->datagram->jiffies_received - fsm->jiffies_start) * 1000 / HZ;
        if (diff_ms >= SII_TIMEOUT) {
            if (fsm->check_once_more) {
                fsm->check_once_more = 0;
            } else {
                EC_SLAVE_ERR(fsm->slave, "SII: Read timeout.\n");
                fsm->state = ec_fsm_sii_state_error;
                return;
            }
        }

        // issue check/fetch datagram again
        ec_fsm_sii_prepare_read_check(fsm, datagram);
        fsm->retries = EC_FSM_RETRIES;
        return;
    }

    // SII value received.
    memcpy(fsm->value, fsm->datagram->data + 6, 4);
    fsm->state = ec_fsm_sii_state_end;
}

/*****************************************************************************/

void ec_fsm_sii_state_start_writing(
        ec_fsm_sii_t *fsm, 
        ec_datagram_t *datagram 
        )
{
    ec_fsm_sii_prepare_write(fsm, datagram);

#ifdef SII_DEBUG
    EC_SLAVE_DBG(fsm->slave, 0, "writing SII data:\n");
    ec_print_data(datagram->data, 8);
#endif

    fsm->retries = EC_FSM_RETRIES;
    fsm->state = ec_fsm_sii_state_write_check;
}

/*****************************************************************************/

void ec_fsm_sii_state_write_check(
        ec_fsm_sii_t *fsm, 
        ec_datagram_t *datagram 
        )
{
    if (fsm->datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--) {
        ec_fsm_sii_prepare_write(fsm, datagram);
        return;
    }

    if (fsm->datagram->state != EC_DATAGRAM_RECEIVED) {
        fsm->state = ec_fsm_sii_state_error;
        EC_SLAVE_ERR(fsm->slave, "Failed to receive SII write datagram: ");
        ec_datagram_print_state(fsm->datagram);
        return;
    }

    if (fsm->datagram->working_counter != 1) {
        fsm->state = ec_fsm_sii_state_error;
        EC_SLAVE_ERR(fsm->slave, "Reception of SII write datagram failed: ");
        ec_datagram_print_wc_error(fsm->datagram);
        return;
    }

    fsm->jiffies_start = fsm->datagram->jiffies_sent;
    fsm->check_once_more = 1;

    ec_fsm_sii_prepare_write_check(fsm, datagram);
    fsm->retries = EC_FSM_RETRIES;
    fsm->state = ec_fsm_sii_state_write_check2;
}

/*****************************************************************************/

void ec_fsm_sii_state_write_check2(
        ec_fsm_sii_t *fsm, 
        ec_datagram_t *datagram 
        )
{
    unsigned long diff_ms;

    if (fsm->datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--) {
        ec_fsm_sii_prepare_write_check(fsm, datagram);
        return;
    }

    if (fsm->datagram->state != EC_DATAGRAM_RECEIVED) {
        fsm->state = ec_fsm_sii_state_error;
        EC_SLAVE_ERR(fsm->slave,
                "Failed to receive SII write check datagram: ");
        ec_datagram_print_state(fsm->datagram);
        return;
    }

    if (fsm->datagram->working_counter != 1) {
        fsm->state = ec_fsm_sii_state_error;
        EC_SLAVE_ERR(fsm->slave,
                "Reception of SII write check datagram failed: ");
        ec_datagram_print_wc_error(fsm->datagram);
        return;
    }

#ifdef SII_DEBUG
    EC_SLAVE_DBG(fsm->slave, 0, "checking SII write state:\n");
    ec_print_data(fsm->datagram->data, 2);
#endif

    if (EC_READ_U8(fsm->datagram->data + 1) & 0x20) {
        EC_SLAVE_ERR(fsm->slave, "SII: Error on last SII command!\n");
        fsm->state = ec_fsm_sii_state_error;
        return;
    }

    /* FIXME: some slaves never answer with the busy flag set...
     * wait a few ms for the write operation to complete. */
    diff_ms = (fsm->datagram->jiffies_received - fsm->jiffies_start) * 1000 / HZ;
    if (diff_ms < SII_INHIBIT) {
#ifdef SII_DEBUG
        EC_SLAVE_DBG(fsm->slave, 0, "too early.\n");
#endif
        // issue check datagram again
        fsm->retries = EC_FSM_RETRIES;
        return;
    }

    if (EC_READ_U8(fsm->datagram->data + 1) & 0x82) { /* busy bit or
                                                    write operation busy bit */
        // still busy... timeout?
        if (diff_ms >= SII_TIMEOUT) {
            if (fsm->check_once_more) {
                fsm->check_once_more = 0;
            } else {
                EC_SLAVE_ERR(fsm->slave, "SII: Write timeout.\n");
                fsm->state = ec_fsm_sii_state_error;
                return;
            }
        }

        // issue check datagram again
        ec_fsm_sii_prepare_write_check(fsm, datagram);
        fsm->retries = EC_FSM_RETRIES;
        return;
    }

    if (EC_READ_U8(fsm->datagram->data + 1) & 0x40) {
        EC_SLAVE_ERR(fsm->slave, "SII: Write operation failed!\n");
        fsm->state = ec_fsm_sii_state_error;
        return;
    }

    // success
    fsm->state = ec_fsm_sii_state_end;
}

/*****************************************************************************/

void ec_fsm_sii_state_error(
        ec_fsm_sii_t *fsm, 
        ec_datagram_t *datagram 
        )
{
}

/*****************************************************************************/

void ec_fsm_sii_state_end(
        ec_fsm_sii_t *fsm, 
        ec_datagram_t *datagram 
        )
{
}

/*****************************************************************************/