fp@1739: /****************************************************************************** fp@1739: * fp@1739: * $Id$ fp@1739: * fp@1739: * Copyright (C) 2006 Florian Pose, Ingenieurgemeinschaft IgH fp@1739: * fp@1739: * This file is part of the IgH EtherCAT Master. fp@1739: * fp@1739: * The IgH EtherCAT Master is free software; you can redistribute it fp@1739: * and/or modify it under the terms of the GNU General Public License fp@1739: * as published by the Free Software Foundation; either version 2 of the fp@1739: * License, or (at your option) any later version. fp@1739: * fp@1739: * The IgH EtherCAT Master is distributed in the hope that it will be fp@1739: * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of fp@1739: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the fp@1739: * GNU General Public License for more details. fp@1739: * fp@1739: * You should have received a copy of the GNU General Public License fp@1739: * along with the IgH EtherCAT Master; if not, write to the Free Software fp@1739: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA fp@1739: * fp@1739: * The right to use EtherCAT Technology is granted and comes free of fp@1739: * charge under condition of compatibility of product made by fp@1739: * Licensee. People intending to distribute/sell products based on the fp@1739: * code, have to sign an agreement to guarantee that products using fp@1739: * software based on IgH EtherCAT master stay compatible with the actual fp@1739: * EtherCAT specification (which are released themselves as an open fp@1739: * standard) as the (only) precondition to have the right to use EtherCAT fp@1739: * Technology, IP and trade marks. fp@1739: * fp@1739: *****************************************************************************/ fp@1739: fp@1739: /** fp@1739: \file fp@1739: EtherCAT finite state machines. fp@1739: */ fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: #include "globals.h" fp@1739: #include "master.h" fp@1739: #include "mailbox.h" fp@1745: #ifdef EC_EOE fp@1744: #include "ethernet.h" fp@1745: #endif fp@1739: #include "fsm_master.h" fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: void ec_fsm_master_state_start(ec_fsm_master_t *); fp@1739: void ec_fsm_master_state_broadcast(ec_fsm_master_t *); fp@1739: void ec_fsm_master_state_read_states(ec_fsm_master_t *); fp@1739: void ec_fsm_master_state_acknowledge(ec_fsm_master_t *); fp@1739: void ec_fsm_master_state_validate_vendor(ec_fsm_master_t *); fp@1739: void ec_fsm_master_state_validate_product(ec_fsm_master_t *); fp@1739: void ec_fsm_master_state_rewrite_addresses(ec_fsm_master_t *); fp@1739: void ec_fsm_master_state_configure_slave(ec_fsm_master_t *); fp@1745: void ec_fsm_master_state_clear_addresses(ec_fsm_master_t *); fp@1739: void ec_fsm_master_state_scan_slaves(ec_fsm_master_t *); fp@1739: void ec_fsm_master_state_write_eeprom(ec_fsm_master_t *); fp@1739: void ec_fsm_master_state_sdodict(ec_fsm_master_t *); fp@1746: void ec_fsm_master_state_pdomap(ec_fsm_master_t *); fp@1739: void ec_fsm_master_state_sdo_request(ec_fsm_master_t *); fp@1739: void ec_fsm_master_state_end(ec_fsm_master_t *); fp@1739: void ec_fsm_master_state_error(ec_fsm_master_t *); fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: Constructor. fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_init(ec_fsm_master_t *fsm, /**< master state machine */ fp@1739: ec_master_t *master, /**< EtherCAT master */ fp@1739: ec_datagram_t *datagram /**< datagram object to use */ fp@1739: ) fp@1739: { fp@1739: fsm->master = master; fp@1739: fsm->datagram = datagram; fp@1739: fsm->state = ec_fsm_master_state_start; fp@1744: fsm->idle = 0; fp@1739: fsm->slaves_responding = 0; fp@1739: fsm->topology_change_pending = 0; fp@1739: fsm->slave_states = EC_SLAVE_STATE_UNKNOWN; fp@1739: fsm->validate = 0; fp@1744: fsm->tainted = 0; fp@1739: fp@1739: // init sub-state-machines fp@1739: ec_fsm_slave_init(&fsm->fsm_slave, fsm->datagram); fp@1739: ec_fsm_sii_init(&fsm->fsm_sii, fsm->datagram); fp@1739: ec_fsm_change_init(&fsm->fsm_change, fsm->datagram); fp@1739: ec_fsm_coe_init(&fsm->fsm_coe, fsm->datagram); fp@1746: ec_fsm_coe_map_init(&fsm->fsm_coe_map, &fsm->fsm_coe); fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: Destructor. fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_clear(ec_fsm_master_t *fsm /**< master state machine */) fp@1739: { fp@1739: // clear sub-state machines fp@1739: ec_fsm_slave_clear(&fsm->fsm_slave); fp@1739: ec_fsm_sii_clear(&fsm->fsm_sii); fp@1739: ec_fsm_change_clear(&fsm->fsm_change); fp@1739: ec_fsm_coe_clear(&fsm->fsm_coe); fp@1746: ec_fsm_coe_map_clear(&fsm->fsm_coe_map); fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: Executes the current state of the state machine. fp@1739: If the state machine's datagram is not sent or received yet, the execution fp@1739: of the state machine is delayed to the next cycle. fp@1739: \return false, if state machine has terminated fp@1739: */ fp@1739: fp@1739: int ec_fsm_master_exec(ec_fsm_master_t *fsm /**< master state machine */) fp@1739: { fp@1739: if (fsm->datagram->state == EC_DATAGRAM_SENT fp@1739: || fsm->datagram->state == EC_DATAGRAM_QUEUED) { fp@1739: // datagram was not sent or received yet. fp@1739: return ec_fsm_master_running(fsm); fp@1739: } fp@1739: fp@1739: fsm->state(fsm); fp@1739: return ec_fsm_master_running(fsm); fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1744: * \return false, if state machine has terminated fp@1744: */ fp@1744: fp@1744: int ec_fsm_master_running( fp@1744: const ec_fsm_master_t *fsm /**< master state machine */ fp@1744: ) fp@1739: { fp@1739: return fsm->state != ec_fsm_master_state_end fp@1739: && fsm->state != ec_fsm_master_state_error; fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1744: * \return true, if the state machine is in an idle phase fp@1744: */ fp@1744: fp@1744: int ec_fsm_master_idle( fp@1744: const ec_fsm_master_t *fsm /**< master state machine */ fp@1744: ) fp@1744: { fp@1744: return fsm->idle; fp@1739: } fp@1739: fp@1739: /****************************************************************************** fp@1744: * master state machine fp@1739: *****************************************************************************/ fp@1739: fp@1739: /** fp@1739: Master state: START. fp@1739: Starts with getting slave count and slave states. fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_state_start(ec_fsm_master_t *fsm) fp@1739: { fp@1744: fsm->idle = 1; fp@1739: ec_datagram_brd(fsm->datagram, 0x0130, 2); fp@1739: fsm->state = ec_fsm_master_state_broadcast; fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: Master state: BROADCAST. fp@1739: Processes the broadcast read slave count and slaves states. fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_state_broadcast(ec_fsm_master_t *fsm /**< master state machine */) fp@1739: { fp@1739: ec_datagram_t *datagram = fsm->datagram; fp@1739: unsigned int i; fp@1739: ec_slave_t *slave; fp@1739: ec_master_t *master = fsm->master; fp@1739: fp@1744: if (datagram->state == EC_DATAGRAM_TIMED_OUT) fp@1744: return; // always retry fp@1744: fp@1744: if (datagram->state != EC_DATAGRAM_RECEIVED) { // link is down fp@1739: fsm->slaves_responding = 0; fp@1739: list_for_each_entry(slave, &master->slaves, list) { fp@1744: ec_slave_set_online_state(slave, EC_SLAVE_OFFLINE); fp@1739: } fp@1739: fsm->state = ec_fsm_master_state_error; fp@1739: return; fp@1739: } fp@1739: fp@1739: // bus topology change? fp@1739: if (datagram->working_counter != fsm->slaves_responding) { fp@1739: fsm->topology_change_pending = 1; fp@1739: fsm->slaves_responding = datagram->working_counter; fp@1739: fp@1739: EC_INFO("%i slave%s responding.\n", fp@1739: fsm->slaves_responding, fp@1739: fsm->slaves_responding == 1 ? "" : "s"); fp@1739: fp@1739: if (master->mode == EC_MASTER_MODE_OPERATION) { fp@1739: if (fsm->slaves_responding == master->slave_count) { fp@1739: fsm->validate = 1; // start validation later fp@1739: } fp@1739: else { fp@1739: EC_WARN("Invalid slave count. Bus in tainted state.\n"); fp@1744: fsm->tainted = 1; fp@1739: } fp@1739: } fp@1739: } fp@1739: fp@1739: // slave states changed? fp@1739: if (EC_READ_U8(datagram->data) != fsm->slave_states) { fp@1739: char states[EC_STATE_STRING_SIZE]; fp@1739: fsm->slave_states = EC_READ_U8(datagram->data); fp@1739: ec_state_string(fsm->slave_states, states); fp@1739: EC_INFO("Slave states: %s.\n", states); fp@1739: } fp@1739: fp@1744: if (fsm->topology_change_pending) { fp@1744: down(&master->scan_sem); fp@1744: if (!master->allow_scan) { fp@1744: up(&master->scan_sem); fp@1744: } fp@1744: else { fp@1744: master->scan_state = EC_REQUEST_IN_PROGRESS; fp@1744: up(&master->scan_sem); fp@1744: fp@1744: // topology change when scan is allowed: fp@1744: // clear all slaves and scan the bus fp@1744: fsm->topology_change_pending = 0; fp@1744: fsm->tainted = 0; fp@1744: fsm->idle = 0; fp@1744: fsm->scan_jiffies = jiffies; fp@1744: fp@1745: #ifdef EC_EOE fp@1744: ec_master_eoe_stop(master); fp@1744: ec_master_clear_eoe_handlers(master); fp@1745: #endif fp@1744: ec_master_destroy_slaves(master); fp@1744: fp@1744: master->slave_count = datagram->working_counter; fp@1744: fp@1744: if (!master->slave_count) { fp@1744: // no slaves present -> finish state machine. fp@1744: master->scan_state = EC_REQUEST_COMPLETE; fp@1744: wake_up_interruptible(&master->scan_queue); fp@1744: fsm->state = ec_fsm_master_state_end; fp@1739: return; fp@1739: } fp@1739: fp@1744: // init slaves fp@1744: for (i = 0; i < master->slave_count; i++) { fp@1744: if (!(slave = (ec_slave_t *) kmalloc(sizeof(ec_slave_t), fp@1744: GFP_ATOMIC))) { fp@1744: EC_ERR("Failed to allocate slave %i!\n", i); fp@1744: ec_master_destroy_slaves(master); fp@1744: master->scan_state = EC_REQUEST_FAILURE; fp@1744: wake_up_interruptible(&master->scan_queue); fp@1744: fsm->state = ec_fsm_master_state_error; fp@1744: return; fp@1744: } fp@1744: fp@1744: if (ec_slave_init(slave, master, i, i + 1)) { fp@1744: // freeing of "slave" already done fp@1744: ec_master_destroy_slaves(master); fp@1744: master->scan_state = EC_REQUEST_FAILURE; fp@1744: wake_up_interruptible(&master->scan_queue); fp@1744: fsm->state = ec_fsm_master_state_error; fp@1744: return; fp@1744: } fp@1744: fp@1744: list_add_tail(&slave->list, &master->slaves); fp@1739: } fp@1739: fp@1745: if (master->debug_level) fp@1745: EC_DBG("Clearing station addresses...\n"); fp@1745: fp@1745: ec_datagram_bwr(datagram, 0x0010, 2); fp@1745: EC_WRITE_U16(datagram->data, 0x0000); fp@1745: fsm->retries = EC_FSM_RETRIES; fp@1745: fsm->state = ec_fsm_master_state_clear_addresses; fp@1744: return; fp@1744: } fp@1739: } fp@1739: fp@1739: // fetch state from each slave fp@1739: fsm->slave = list_entry(master->slaves.next, ec_slave_t, list); fp@1739: ec_datagram_nprd(fsm->datagram, fsm->slave->station_address, 0x0130, 2); fp@1739: fsm->retries = EC_FSM_RETRIES; fp@1739: fsm->state = ec_fsm_master_state_read_states; fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1744: * Check for pending EEPROM write requests and process one. fp@1744: * \return non-zero, if an EEPROM write request is processed. fp@1744: */ fp@1744: fp@1744: int ec_fsm_master_action_process_eeprom( fp@1744: ec_fsm_master_t *fsm /**< master state machine */ fp@1744: ) fp@1739: { fp@1739: ec_master_t *master = fsm->master; fp@1744: ec_eeprom_write_request_t *request; fp@1739: ec_slave_t *slave; fp@1744: fp@1744: // search the first request to be processed fp@1744: while (1) { fp@1744: down(&master->eeprom_sem); fp@1744: if (list_empty(&master->eeprom_requests)) { fp@1744: up(&master->eeprom_sem); fp@1744: break; fp@1744: } fp@1744: // get first request fp@1744: request = list_entry(master->eeprom_requests.next, fp@1744: ec_eeprom_write_request_t, list); fp@1744: list_del_init(&request->list); // dequeue fp@1744: request->state = EC_REQUEST_IN_PROGRESS; fp@1744: up(&master->eeprom_sem); fp@1744: fp@1744: slave = request->slave; fp@1746: if (slave->online_state == EC_SLAVE_OFFLINE) { fp@1746: EC_ERR("Discarding EEPROM data, slave %i offline.\n", fp@1744: slave->ring_position); fp@1744: request->state = EC_REQUEST_FAILURE; fp@1744: wake_up(&master->eeprom_queue); fp@1744: continue; fp@1744: } fp@1744: fp@1744: // found pending EEPROM write operation. execute it! fp@1744: if (master->debug_level) fp@1744: EC_DBG("Writing EEPROM data to slave %i...\n", fp@1744: slave->ring_position); fp@1744: fsm->eeprom_request = request; fp@1744: fsm->eeprom_index = 0; fp@1746: ec_fsm_sii_write(&fsm->fsm_sii, request->slave, request->word_offset, fp@1746: request->data, EC_FSM_SII_NODE); fp@1744: fsm->state = ec_fsm_master_state_write_eeprom; fp@1744: fsm->state(fsm); // execute immediately fp@1744: return 1; fp@1744: } fp@1744: fp@1744: return 0; fp@1744: } fp@1744: fp@1744: /*****************************************************************************/ fp@1744: fp@1744: /** fp@1744: * Check for pending SDO requests and process one. fp@1744: * \return non-zero, if an SDO request is processed. fp@1744: */ fp@1744: fp@1744: int ec_fsm_master_action_process_sdo( fp@1744: ec_fsm_master_t *fsm /**< master state machine */ fp@1744: ) fp@1744: { fp@1744: ec_master_t *master = fsm->master; fp@1744: ec_sdo_request_t *request; fp@1744: ec_slave_t *slave; fp@1744: fp@1744: // search the first request to be processed fp@1744: while (1) { fp@1744: down(&master->sdo_sem); fp@1744: if (list_empty(&master->sdo_requests)) { fp@1744: up(&master->sdo_sem); fp@1744: break; fp@1744: } fp@1744: // get first request fp@1744: request = fp@1744: list_entry(master->sdo_requests.next, ec_sdo_request_t, list); fp@1744: list_del_init(&request->list); // dequeue fp@1744: request->state = EC_REQUEST_IN_PROGRESS; fp@1744: up(&master->sdo_sem); fp@1744: fp@1746: slave = request->entry->sdo->slave; fp@1744: if (slave->current_state == EC_SLAVE_STATE_INIT || fp@1744: slave->online_state == EC_SLAVE_OFFLINE || fp@1744: slave->error_flag) { fp@1744: EC_ERR("Discarding SDO request, slave %i not ready.\n", fp@1744: slave->ring_position); fp@1744: request->state = EC_REQUEST_FAILURE; fp@1744: wake_up(&master->sdo_queue); fp@1744: continue; fp@1744: } fp@1744: fp@1744: // found pending SDO request. execute it! fp@1744: if (master->debug_level) fp@1744: EC_DBG("Processing SDO request for slave %i...\n", fp@1744: slave->ring_position); fp@1744: fp@1744: // start uploading SDO fp@1744: fsm->idle = 0; fp@1744: fsm->slave = slave; fp@1744: fsm->sdo_request = request; fp@1744: fsm->state = ec_fsm_master_state_sdo_request; fp@1744: ec_fsm_coe_upload(&fsm->fsm_coe, slave, fsm->sdo_request); fp@1744: ec_fsm_coe_exec(&fsm->fsm_coe); // execute immediately fp@1744: return 1; fp@1744: } fp@1744: fp@1744: return 0; fp@1744: } fp@1744: fp@1744: /*****************************************************************************/ fp@1744: fp@1744: /** fp@1746: * Check for slaves that are not configured and configure them. fp@1744: */ fp@1744: fp@1744: int ec_fsm_master_action_configure( fp@1744: ec_fsm_master_t *fsm /**< master state machine */ fp@1744: ) fp@1744: { fp@1744: ec_slave_t *slave; fp@1744: ec_master_t *master = fsm->master; fp@1739: char old_state[EC_STATE_STRING_SIZE], new_state[EC_STATE_STRING_SIZE]; fp@1739: fp@1739: // check if any slaves are not in the state, they're supposed to be fp@1744: // FIXME do not check all slaves in every cycle... fp@1739: list_for_each_entry(slave, &master->slaves, list) { fp@1739: if (slave->error_flag fp@1744: || slave->online_state == EC_SLAVE_OFFLINE fp@1744: || slave->requested_state == EC_SLAVE_STATE_UNKNOWN fp@1744: || (slave->current_state == slave->requested_state fp@1744: && slave->self_configured)) continue; fp@1739: fp@1739: if (master->debug_level) { fp@1739: ec_state_string(slave->current_state, old_state); fp@1739: if (slave->current_state != slave->requested_state) { fp@1739: ec_state_string(slave->requested_state, new_state); fp@1739: EC_DBG("Changing state of slave %i (%s -> %s).\n", fp@1744: slave->ring_position, old_state, new_state); fp@1739: } fp@1739: else if (!slave->self_configured) { fp@1739: EC_DBG("Reconfiguring slave %i (%s).\n", fp@1744: slave->ring_position, old_state); fp@1739: } fp@1739: } fp@1739: fp@1744: fsm->idle = 0; fp@1739: fsm->slave = slave; fp@1744: fsm->state = ec_fsm_master_state_configure_slave; fp@1739: ec_fsm_slave_start_conf(&fsm->fsm_slave, slave); fp@1739: ec_fsm_slave_exec(&fsm->fsm_slave); // execute immediately fp@1744: return 1; fp@1744: } fp@1744: fp@1744: if (fsm->config_error) fp@1744: master->config_state = EC_REQUEST_FAILURE; fp@1744: else fp@1744: master->config_state = EC_REQUEST_COMPLETE; fp@1744: wake_up_interruptible(&master->config_queue); fp@1744: return 0; fp@1744: } fp@1744: fp@1744: /*****************************************************************************/ fp@1744: fp@1744: /** fp@1744: Master action: PROC_STATES. fp@1744: Processes the slave states. fp@1744: */ fp@1744: fp@1744: void ec_fsm_master_action_process_states(ec_fsm_master_t *fsm fp@1744: /**< master state machine */ fp@1744: ) fp@1744: { fp@1744: ec_master_t *master = fsm->master; fp@1744: ec_slave_t *slave; fp@1744: fp@1744: down(&master->config_sem); fp@1744: if (!master->allow_config) { fp@1744: up(&master->config_sem); fp@1744: } fp@1744: else { fp@1744: master->config_state = EC_REQUEST_IN_PROGRESS; fp@1744: fsm->config_error = 0; fp@1744: up(&master->config_sem); fp@1744: fp@1744: // check for pending slave configurations fp@1744: if (ec_fsm_master_action_configure(fsm)) fp@1744: return; fp@1744: } fp@1744: fp@1744: // Check for a pending SDO request fp@1744: if (ec_fsm_master_action_process_sdo(fsm)) fp@1744: return; fp@1739: fp@1739: if (master->mode == EC_MASTER_MODE_IDLE) { fp@1739: fp@1739: // check, if slaves have an SDO dictionary to read out. fp@1739: list_for_each_entry(slave, &master->slaves, list) { fp@1739: if (!(slave->sii_mailbox_protocols & EC_MBOX_COE) fp@1739: || slave->sdo_dictionary_fetched fp@1739: || slave->current_state == EC_SLAVE_STATE_INIT fp@1739: || jiffies - slave->jiffies_preop < EC_WAIT_SDO_DICT * HZ fp@1744: || slave->online_state == EC_SLAVE_OFFLINE fp@1739: || slave->error_flag) continue; fp@1739: fp@1739: if (master->debug_level) { fp@1739: EC_DBG("Fetching SDO dictionary from slave %i.\n", fp@1739: slave->ring_position); fp@1739: } fp@1739: fp@1739: slave->sdo_dictionary_fetched = 1; fp@1739: fp@1739: // start fetching SDO dictionary fp@1744: fsm->idle = 0; fp@1739: fsm->slave = slave; fp@1739: fsm->state = ec_fsm_master_state_sdodict; fp@1739: ec_fsm_coe_dictionary(&fsm->fsm_coe, slave); fp@1739: ec_fsm_coe_exec(&fsm->fsm_coe); // execute immediately fp@1739: return; fp@1739: } fp@1739: fp@1746: // check, if slaves have their PDO mapping to be read. fp@1746: list_for_each_entry(slave, &master->slaves, list) { fp@1746: if (!(slave->sii_mailbox_protocols & EC_MBOX_COE) fp@1746: || slave->pdo_mapping_fetched fp@1746: || !slave->sdo_dictionary_fetched fp@1746: || slave->current_state == EC_SLAVE_STATE_INIT fp@1746: || slave->online_state == EC_SLAVE_OFFLINE) continue; fp@1746: fp@1746: if (master->debug_level) { fp@1746: EC_DBG("Fetching PDO mapping from slave %i via CoE.\n", fp@1746: slave->ring_position); fp@1746: } fp@1746: fp@1746: slave->pdo_mapping_fetched = 1; fp@1746: fp@1746: // start fetching PDO mapping fp@1746: fsm->idle = 0; fp@1746: fsm->state = ec_fsm_master_state_pdomap; fp@1746: ec_fsm_coe_map_start(&fsm->fsm_coe_map, slave); fp@1746: ec_fsm_coe_map_exec(&fsm->fsm_coe_map); // execute immediately fp@1746: return; fp@1746: } fp@1746: fp@1739: // check for pending EEPROM write operations. fp@1744: if (ec_fsm_master_action_process_eeprom(fsm)) fp@1744: return; // EEPROM write request found fp@1739: } fp@1739: fp@1739: fsm->state = ec_fsm_master_state_end; fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: Master action: Get state of next slave. fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_action_next_slave_state(ec_fsm_master_t *fsm fp@1739: /**< master state machine */) fp@1739: { fp@1739: ec_master_t *master = fsm->master; fp@1739: ec_slave_t *slave = fsm->slave; fp@1739: fp@1739: // is there another slave to query? fp@1739: if (slave->list.next != &master->slaves) { fp@1739: // process next slave fp@1744: fsm->idle = 1; fp@1744: fsm->slave = list_entry(slave->list.next, ec_slave_t, list); fp@1739: ec_datagram_nprd(fsm->datagram, fsm->slave->station_address, fp@1739: 0x0130, 2); fp@1739: fsm->retries = EC_FSM_RETRIES; fp@1739: fsm->state = ec_fsm_master_state_read_states; fp@1739: return; fp@1739: } fp@1739: fp@1739: // all slave states read fp@1739: fp@1739: // check, if a bus validation has to be done fp@1739: if (fsm->validate) { fp@1739: fsm->validate = 0; fp@1739: list_for_each_entry(slave, &master->slaves, list) { fp@1744: if (slave->online_state == EC_SLAVE_ONLINE) continue; fp@1739: fp@1739: // At least one slave is offline. validate! fp@1739: EC_INFO("Validating bus.\n"); fp@1744: fsm->idle = 0; fp@1739: fsm->slave = list_entry(master->slaves.next, ec_slave_t, list); fp@1739: fsm->state = ec_fsm_master_state_validate_vendor; fp@1739: ec_fsm_sii_read(&fsm->fsm_sii, slave, 0x0008, EC_FSM_SII_POSITION); fp@1739: ec_fsm_sii_exec(&fsm->fsm_sii); // execute immediately fp@1739: return; fp@1739: } fp@1739: } fp@1739: fp@1739: ec_fsm_master_action_process_states(fsm); fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: Master state: READ STATES. fp@1739: Fetches the AL- and online state of a slave. fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_state_read_states(ec_fsm_master_t *fsm /**< master state machine */) fp@1739: { fp@1739: ec_slave_t *slave = fsm->slave; fp@1739: ec_datagram_t *datagram = fsm->datagram; fp@1744: fp@1744: if (datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--) fp@1744: return; fp@1739: fp@1739: if (datagram->state != EC_DATAGRAM_RECEIVED) { fp@1744: EC_ERR("Failed to receive AL state datagram for slave %i" fp@1745: " (datagram state %i)\n", fp@1745: slave->ring_position, datagram->state); fp@1739: fsm->state = ec_fsm_master_state_error; fp@1739: return; fp@1739: } fp@1739: fp@1739: // did the slave not respond to its station address? fp@1745: if (datagram->working_counter == 0) { fp@1744: ec_slave_set_online_state(slave, EC_SLAVE_OFFLINE); fp@1739: ec_fsm_master_action_next_slave_state(fsm); fp@1739: return; fp@1739: } fp@1739: fp@1745: // FIXME what to to on multiple response? fp@1745: fp@1739: // slave responded fp@1744: ec_slave_set_state(slave, EC_READ_U8(datagram->data)); // set app state first fp@1744: ec_slave_set_online_state(slave, EC_SLAVE_ONLINE); fp@1739: fp@1739: // check, if new slave state has to be acknowledged fp@1739: if (slave->current_state & EC_SLAVE_STATE_ACK_ERR && !slave->error_flag) { fp@1744: fsm->idle = 0; fp@1744: fsm->state = ec_fsm_master_state_acknowledge; fp@1739: ec_fsm_change_ack(&fsm->fsm_change, slave); fp@1739: ec_fsm_change_exec(&fsm->fsm_change); fp@1739: return; fp@1739: } fp@1739: fp@1739: ec_fsm_master_action_next_slave_state(fsm); fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: Master state: ACKNOWLEDGE fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_state_acknowledge(ec_fsm_master_t *fsm /**< master state machine */) fp@1739: { fp@1739: ec_slave_t *slave = fsm->slave; fp@1739: fp@1739: if (ec_fsm_change_exec(&fsm->fsm_change)) return; fp@1739: fp@1739: if (!ec_fsm_change_success(&fsm->fsm_change)) { fp@1739: fsm->slave->error_flag = 1; fp@1739: EC_ERR("Failed to acknowledge state change on slave %i.\n", fp@1739: slave->ring_position); fp@1739: fsm->state = ec_fsm_master_state_error; fp@1739: return; fp@1739: } fp@1739: fp@1739: ec_fsm_master_action_next_slave_state(fsm); fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: Master state: VALIDATE_VENDOR. fp@1739: Validates the vendor ID of a slave. fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_state_validate_vendor(ec_fsm_master_t *fsm /**< master state machine */) fp@1739: { fp@1739: ec_slave_t *slave = fsm->slave; fp@1739: fp@1739: if (ec_fsm_sii_exec(&fsm->fsm_sii)) return; fp@1739: fp@1739: if (!ec_fsm_sii_success(&fsm->fsm_sii)) { fp@1739: fsm->slave->error_flag = 1; fp@1739: EC_ERR("Failed to validate vendor ID of slave %i.\n", fp@1739: slave->ring_position); fp@1739: fsm->state = ec_fsm_master_state_error; fp@1739: return; fp@1739: } fp@1739: fp@1739: if (EC_READ_U32(fsm->fsm_sii.value) != slave->sii_vendor_id) { fp@1739: EC_ERR("Slave %i has an invalid vendor ID!\n", slave->ring_position); fp@1739: fsm->state = ec_fsm_master_state_error; fp@1739: return; fp@1739: } fp@1739: fp@1739: // vendor ID is ok. check product code. fp@1739: fsm->state = ec_fsm_master_state_validate_product; fp@1739: ec_fsm_sii_read(&fsm->fsm_sii, slave, 0x000A, EC_FSM_SII_POSITION); fp@1739: ec_fsm_sii_exec(&fsm->fsm_sii); // execute immediately fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: Master action: ADDRESS. fp@1739: Looks for slave, that have lost their configuration and writes fp@1739: their station address, so that they can be reconfigured later. fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_action_addresses(ec_fsm_master_t *fsm /**< master state machine */) fp@1739: { fp@1739: ec_datagram_t *datagram = fsm->datagram; fp@1739: fp@1744: while (fsm->slave->online_state == EC_SLAVE_ONLINE) { fp@1739: if (fsm->slave->list.next == &fsm->master->slaves) { // last slave? fp@1744: fsm->state = ec_fsm_master_state_end; fp@1739: return; fp@1739: } fp@1739: // check next slave fp@1739: fsm->slave = list_entry(fsm->slave->list.next, ec_slave_t, list); fp@1739: } fp@1739: fp@1739: if (fsm->master->debug_level) fp@1739: EC_DBG("Reinitializing slave %i.\n", fsm->slave->ring_position); fp@1739: fp@1739: // write station address fp@1739: ec_datagram_apwr(datagram, fsm->slave->ring_position, 0x0010, 2); fp@1739: EC_WRITE_U16(datagram->data, fsm->slave->station_address); fp@1739: fsm->retries = EC_FSM_RETRIES; fp@1739: fsm->state = ec_fsm_master_state_rewrite_addresses; fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: Master state: VALIDATE_PRODUCT. fp@1739: Validates the product ID of a slave. fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_state_validate_product(ec_fsm_master_t *fsm /**< master state machine */) fp@1739: { fp@1739: ec_slave_t *slave = fsm->slave; fp@1739: fp@1739: if (ec_fsm_sii_exec(&fsm->fsm_sii)) return; fp@1739: fp@1739: if (!ec_fsm_sii_success(&fsm->fsm_sii)) { fp@1739: fsm->slave->error_flag = 1; fp@1739: EC_ERR("Failed to validate product code of slave %i.\n", fp@1739: slave->ring_position); fp@1739: fsm->state = ec_fsm_master_state_error; fp@1739: return; fp@1739: } fp@1739: fp@1739: if (EC_READ_U32(fsm->fsm_sii.value) != slave->sii_product_code) { fp@1739: EC_ERR("Slave %i: invalid product code!\n", slave->ring_position); fp@1739: EC_ERR("expected 0x%08X, got 0x%08X.\n", slave->sii_product_code, fp@1739: EC_READ_U32(fsm->fsm_sii.value)); fp@1739: fsm->state = ec_fsm_master_state_error; fp@1739: return; fp@1739: } fp@1739: fp@1739: // have all states been validated? fp@1739: if (slave->list.next == &fsm->master->slaves) { fp@1744: fsm->topology_change_pending = 0; fp@1744: fsm->tainted = 0; fp@1739: fsm->slave = list_entry(fsm->master->slaves.next, ec_slave_t, list); fp@1739: // start writing addresses to offline slaves fp@1739: ec_fsm_master_action_addresses(fsm); fp@1739: return; fp@1739: } fp@1739: fp@1739: // validate next slave fp@1739: fsm->slave = list_entry(fsm->slave->list.next, ec_slave_t, list); fp@1739: fsm->state = ec_fsm_master_state_validate_vendor; fp@1739: ec_fsm_sii_read(&fsm->fsm_sii, slave, 0x0008, EC_FSM_SII_POSITION); fp@1739: ec_fsm_sii_exec(&fsm->fsm_sii); // execute immediately fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: Master state: REWRITE ADDRESS. fp@1739: Checks, if the new station address has been written to the slave. fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_state_rewrite_addresses(ec_fsm_master_t *fsm fp@1739: /**< master state machine */ fp@1739: ) fp@1739: { fp@1739: ec_slave_t *slave = fsm->slave; fp@1739: ec_datagram_t *datagram = fsm->datagram; fp@1739: fp@1744: if (datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--) fp@1744: return; fp@1739: fp@1739: if (datagram->state != EC_DATAGRAM_RECEIVED) { fp@1744: EC_ERR("Failed to receive address datagram for slave %i" fp@1744: " (datagram state %i).\n", fp@1744: slave->ring_position, datagram->state); fp@1739: fsm->state = ec_fsm_master_state_error; fp@1739: return; fp@1739: } fp@1739: fp@1739: if (datagram->working_counter != 1) { fp@1745: EC_ERR("Failed to write station address of slave %i: ", fp@1739: slave->ring_position); fp@1745: ec_datagram_print_wc_error(datagram); fp@1739: fsm->state = ec_fsm_master_state_error; fp@1739: return; fp@1739: } fp@1739: fp@1739: if (fsm->slave->list.next == &fsm->master->slaves) { // last slave? fp@1744: fsm->state = ec_fsm_master_state_end; fp@1739: return; fp@1739: } fp@1739: fp@1739: // check next slave fp@1739: fsm->slave = list_entry(fsm->slave->list.next, ec_slave_t, list); fp@1739: // Write new station address to slave fp@1739: ec_fsm_master_action_addresses(fsm); fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1745: * Master state: CLEAR ADDRESSES. fp@1745: */ fp@1745: fp@1745: void ec_fsm_master_state_clear_addresses( fp@1745: ec_fsm_master_t *fsm /**< master state machine */ fp@1745: ) fp@1745: { fp@1745: ec_master_t *master = fsm->master; fp@1745: ec_datagram_t *datagram = fsm->datagram; fp@1745: fp@1745: if (datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--) fp@1745: return; fp@1745: fp@1745: if (datagram->state != EC_DATAGRAM_RECEIVED) { fp@1745: EC_ERR("Failed to receive address clearing datagram (state %i).\n", fp@1745: datagram->state); fp@1745: fsm->state = ec_fsm_master_state_error; fp@1745: return; fp@1745: } fp@1745: fp@1745: if (datagram->working_counter != master->slave_count) { fp@1745: EC_WARN("Failed to clear all station addresses: Cleared %u of %u", fp@1745: datagram->working_counter, master->slave_count); fp@1745: } fp@1745: fp@1745: EC_INFO("Scanning bus.\n"); fp@1745: fp@1745: // begin scanning of slaves fp@1745: fsm->slave = list_entry(master->slaves.next, ec_slave_t, list); fp@1745: fsm->state = ec_fsm_master_state_scan_slaves; fp@1745: ec_fsm_slave_start_scan(&fsm->fsm_slave, fsm->slave); fp@1745: ec_fsm_slave_exec(&fsm->fsm_slave); // execute immediately fp@1745: } fp@1745: fp@1745: /*****************************************************************************/ fp@1745: fp@1745: /** fp@1744: * Master state: SCAN SLAVES. fp@1744: * Executes the sub-statemachine for the scanning of a slave. fp@1744: */ fp@1744: fp@1744: void ec_fsm_master_state_scan_slaves( fp@1744: ec_fsm_master_t *fsm /**< master state machine */ fp@1744: ) fp@1739: { fp@1739: ec_master_t *master = fsm->master; fp@1744: ec_slave_t *slave = fsm->slave; fp@1739: fp@1739: if (ec_fsm_slave_exec(&fsm->fsm_slave)) // execute slave state machine fp@1739: return; fp@1739: fp@1745: #ifdef EC_EOE fp@1744: if (slave->sii_mailbox_protocols & EC_MBOX_EOE) { fp@1744: // create EoE handler for this slave fp@1744: ec_eoe_t *eoe; fp@1744: if (!(eoe = kmalloc(sizeof(ec_eoe_t), GFP_KERNEL))) { fp@1744: EC_ERR("Failed to allocate EoE handler memory for slave %u!\n", fp@1744: slave->ring_position); fp@1744: } fp@1744: else if (ec_eoe_init(eoe, slave)) { fp@1744: EC_ERR("Failed to init EoE handler for slave %u!\n", fp@1744: slave->ring_position); fp@1744: kfree(eoe); fp@1744: } fp@1744: else { fp@1744: list_add_tail(&eoe->list, &master->eoe_handlers); fp@1744: } fp@1744: } fp@1745: #endif fp@1744: fp@1739: // another slave to fetch? fp@1744: if (slave->list.next != &master->slaves) { fp@1744: fsm->slave = list_entry(slave->list.next, ec_slave_t, list); fp@1739: ec_fsm_slave_start_scan(&fsm->fsm_slave, fsm->slave); fp@1739: ec_fsm_slave_exec(&fsm->fsm_slave); // execute immediately fp@1739: return; fp@1739: } fp@1739: fp@1744: EC_INFO("Bus scanning completed in %u ms.\n", fp@1744: (u32) (jiffies - fsm->scan_jiffies) * 1000 / HZ); fp@1744: fp@1745: #ifdef EC_EOE fp@1744: // check if EoE processing has to be started fp@1744: ec_master_eoe_start(master); fp@1745: #endif fp@1744: fp@1744: master->scan_state = EC_REQUEST_COMPLETE; fp@1744: wake_up_interruptible(&master->scan_queue); fp@1739: fp@1739: fsm->state = ec_fsm_master_state_end; fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: Master state: CONFIGURE SLAVES. fp@1739: Starts configuring a slave. fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_state_configure_slave(ec_fsm_master_t *fsm fp@1739: /**< master state machine */ fp@1739: ) fp@1739: { fp@1739: if (ec_fsm_slave_exec(&fsm->fsm_slave)) // execute slave's state machine fp@1739: return; fp@1739: fp@1744: if (!ec_fsm_slave_success(&fsm->fsm_slave)) fp@1744: fsm->config_error = 1; fp@1744: fp@1744: // configure next slave, if necessary fp@1744: if (ec_fsm_master_action_configure(fsm)) fp@1744: return; fp@1744: fp@1744: fsm->state = ec_fsm_master_state_end; fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: Master state: WRITE EEPROM. fp@1739: */ fp@1739: fp@1744: void ec_fsm_master_state_write_eeprom( fp@1744: ec_fsm_master_t *fsm /**< master state machine */) fp@1744: { fp@1744: ec_master_t *master = fsm->master; fp@1744: ec_eeprom_write_request_t *request = fsm->eeprom_request; fp@1744: ec_slave_t *slave = request->slave; fp@1739: fp@1739: if (ec_fsm_sii_exec(&fsm->fsm_sii)) return; fp@1739: fp@1739: if (!ec_fsm_sii_success(&fsm->fsm_sii)) { fp@1744: slave->error_flag = 1; fp@1744: EC_ERR("Failed to write EEPROM data to slave %i.\n", fp@1744: slave->ring_position); fp@1744: request->state = EC_REQUEST_FAILURE; fp@1744: wake_up(&master->eeprom_queue); fp@1744: fsm->state = ec_fsm_master_state_error; fp@1744: return; fp@1744: } fp@1744: fp@1744: fsm->eeprom_index++; fp@1746: if (fsm->eeprom_index < request->word_size) { fp@1744: ec_fsm_sii_write(&fsm->fsm_sii, slave, fp@1746: request->word_offset + fsm->eeprom_index, fp@1746: request->data + fsm->eeprom_index * 2, fp@1744: EC_FSM_SII_NODE); fp@1739: ec_fsm_sii_exec(&fsm->fsm_sii); // execute immediately fp@1739: return; fp@1739: } fp@1739: fp@1739: // finished writing EEPROM fp@1744: if (master->debug_level) fp@1746: EC_DBG("Finished writing %u words of EEPROM data to slave %u.\n", fp@1746: request->word_size, slave->ring_position); fp@1744: request->state = EC_REQUEST_COMPLETE; fp@1744: wake_up(&master->eeprom_queue); fp@1739: fp@1739: // TODO: Evaluate new EEPROM contents! fp@1739: fp@1744: // check for another EEPROM write request fp@1744: if (ec_fsm_master_action_process_eeprom(fsm)) fp@1744: return; // processing another request fp@1744: fp@1744: fsm->state = ec_fsm_master_state_end; fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: Master state: SDODICT. fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_state_sdodict(ec_fsm_master_t *fsm /**< master state machine */) fp@1739: { fp@1739: ec_slave_t *slave = fsm->slave; fp@1739: ec_master_t *master = fsm->master; fp@1739: fp@1739: if (ec_fsm_coe_exec(&fsm->fsm_coe)) return; fp@1739: fp@1739: if (!ec_fsm_coe_success(&fsm->fsm_coe)) { fp@1739: fsm->state = ec_fsm_master_state_error; fp@1739: return; fp@1739: } fp@1739: fp@1739: // SDO dictionary fetching finished fp@1739: fp@1739: if (master->debug_level) { fp@1739: unsigned int sdo_count, entry_count; fp@1739: ec_slave_sdo_dict_info(slave, &sdo_count, &entry_count); fp@1739: EC_DBG("Fetched %i SDOs and %i entries from slave %i.\n", fp@1739: sdo_count, entry_count, slave->ring_position); fp@1739: } fp@1739: fp@1744: fsm->state = ec_fsm_master_state_end; fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1746: * Scan the PDO mapping of a slave. fp@1746: */ fp@1746: fp@1746: void ec_fsm_master_state_pdomap( fp@1746: ec_fsm_master_t *fsm /**< master state machine */ fp@1746: ) fp@1746: { fp@1746: if (ec_fsm_coe_map_exec(&fsm->fsm_coe_map)) return; fp@1746: fp@1746: if (!ec_fsm_coe_map_success(&fsm->fsm_coe_map)) { fp@1746: fsm->state = ec_fsm_master_state_error; fp@1746: return; fp@1746: } fp@1746: fp@1746: // fetching of PDO mapping finished fp@1746: fsm->state = ec_fsm_master_state_end; fp@1746: } fp@1746: fp@1746: /*****************************************************************************/ fp@1746: fp@1746: /** fp@1739: Master state: SDO REQUEST. fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_state_sdo_request(ec_fsm_master_t *fsm /**< master state machine */) fp@1739: { fp@1739: ec_master_t *master = fsm->master; fp@1739: ec_sdo_request_t *request = fsm->sdo_request; fp@1739: fp@1739: if (ec_fsm_coe_exec(&fsm->fsm_coe)) return; fp@1739: fp@1739: if (!ec_fsm_coe_success(&fsm->fsm_coe)) { fp@1744: EC_DBG("Failed to process SDO request for slave %i.\n", fp@1744: fsm->slave->ring_position); fp@1744: request->state = EC_REQUEST_FAILURE; fp@1744: wake_up(&master->sdo_queue); fp@1744: fsm->state = ec_fsm_master_state_error; fp@1744: return; fp@1744: } fp@1744: fp@1744: // SDO request finished fp@1744: request->state = EC_REQUEST_COMPLETE; fp@1744: wake_up(&master->sdo_queue); fp@1744: fp@1744: if (master->debug_level) fp@1744: EC_DBG("Finished SDO request for slave %i.\n", fp@1744: fsm->slave->ring_position); fp@1744: fp@1744: // check for another SDO request fp@1744: if (ec_fsm_master_action_process_sdo(fsm)) fp@1744: return; // processing another request fp@1744: fp@1744: fsm->state = ec_fsm_master_state_end; fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: State: ERROR. fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_state_error( fp@1739: ec_fsm_master_t *fsm /**< master state machine */ fp@1739: ) fp@1739: { fp@1739: fsm->state = ec_fsm_master_state_start; fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: fp@1739: /** fp@1739: State: END. fp@1739: */ fp@1739: fp@1739: void ec_fsm_master_state_end(ec_fsm_master_t *fsm /**< master state machine */) fp@1739: { fp@1739: fsm->state = ec_fsm_master_state_start; fp@1739: } fp@1739: fp@1739: /*****************************************************************************/ fp@1739: