/***************************************************************************** * * Copyright (C) 2024 Bjarne von Horn, Ingenieurgemeinschaft IgH * * This file is part of the IgH EtherCAT master userspace library. * * The IgH EtherCAT master userspace library is free software; you can * redistribute it and/or modify it under the terms of the GNU Lesser General * Public License as published by the Free Software Foundation; version 2.1 * of the License. * * The IgH EtherCAT master userspace library 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 Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with the IgH EtherCAT master userspace library. If not, see * . * ****************************************************************************/ #include "fakeethercat.h" #include #include #include #include #include #include #include #include static std::ostream &operator<<(std::ostream &os, const sdo_address &a) { os << std::setfill('0') << std::hex << std::setw(6) << a.getCombined(); return os; } static std::ostream &operator<<(std::ostream &os, const ec_address &a) { os << std::setfill('0') << std::hex << std::setw(8) << a.getCombined(); return os; } static void add_spaces(std::ostream &out, int const num) { for (int i = 0; i < num; ++i) { out << ' '; } } template static void map2Json(std::ostream &out, const Map &map, Func &&print_func, int indent = 0) { indent += 4; out << "{"; bool is_first = true; for (const auto &kv : map) { if (is_first) { out << '\n'; is_first = false; } else { out << ",\n"; } add_spaces(out, indent); out << "\"0x" << std::hex << std::setfill('0') << std::setw(2 * sizeof(typename Map::key_type)); out << kv.first << "\": "; print_func(out, kv.second); } out << '\n'; add_spaces(out, indent - 4); out << "}"; } size_t pdo::sizeInBytes() const { size_t ans = 0; for (const auto &entry : entries) { ans += entry.bit_length; } return (ans + 7) / 8; } Offset pdo::findEntry(uint16_t idx, uint8_t subindex) const { size_t offset_bits = 0; for (const auto &entry : entries) { if (entry.index == idx && entry.subindex == subindex) { return Offset(offset_bits / 8, offset_bits % 8); } offset_bits += entry.bit_length; } return NotFound; } ec_domain::ec_domain(rtipc *rtipc, const char *prefix, ec_master_t *master) : rt_group(rtipc_create_group(rtipc, 1.0)), prefix(prefix), master(master) { } int ec_domain::activate() { std::unordered_set slaves; connected.resize(mapped_pdos.size()); size_t idx = 0; for (const auto &pdo : mapped_pdos) { slaves.insert(pdo.slave_address.getCombined()); void *rt_pdo = nullptr; char buf[512]; const auto fmt = snprintf(buf, sizeof(buf), "%s/%d/%08X/%04X", prefix, master->getId(), pdo.slave_address.getCombined(), pdo.pdo_index); if (fmt < 0 || fmt >= (int)sizeof(buf)) { return -ENOBUFS; } switch (pdo.dir) { case EC_DIR_OUTPUT: rt_pdo = rtipc_txpdo(rt_group, buf, rtipc_uint8_T, data.data() + pdo.offset, pdo.size_bytes); std::cerr << "Registering " << buf << " as Output\n"; break; case EC_DIR_INPUT: rt_pdo = rtipc_rxpdo(rt_group, buf, rtipc_uint8_T, data.data() + pdo.offset, pdo.size_bytes, connected.data() + idx); std::cerr << "Registering " << buf << " as Input\n"; break; default: std::cerr << "Unknown direction " << pdo.dir << '\n'; return -1; } if (!rt_pdo) { std::cerr << "Failed to register RtIPC PDO\n"; return -1; } ++idx; } activated_ = true; numSlaves = slaves.size(); return 0; } int ec_domain::process() { rtipc_rx(rt_group); return 0; } int ec_domain::queue() { rtipc_tx(rt_group); return 0; } ssize_t ec_domain::map(ec_slave_config const &config, unsigned int syncManager, uint16_t pdo_index) { if (activated_) return -1; for (const auto &pdo : mapped_pdos) { if (pdo.slave_address == config.address && syncManager == pdo.syncManager && pdo_index == pdo.pdo_index) { // already mapped; return pdo.offset; } } const auto ans = data.size(); const auto size = config.sync_managers.at(syncManager).pdos.at(pdo_index).sizeInBytes(); mapped_pdos.emplace_back(ans, size, config.address, syncManager, pdo_index, config.sync_managers.at(syncManager).dir); data.resize(ans + size); return ans; } uint8_t *ecrt_domain_data( const ec_domain_t *domain) { return domain->getData(); } int ecrt_domain_process( ec_domain_t *domain) { return domain->process(); } int ecrt_domain_queue( ec_domain_t *domain) { return domain->queue(); } int ecrt_domain_state( const ec_domain_t *domain, /**< Domain. */ ec_domain_state_t *state /**< Pointer to a state object to store the information. */ ) { state->working_counter = domain->getNumSlaves(); state->redundancy_active = 0; state->wc_state = EC_WC_COMPLETE; return 0; } int ec_master::activate() { for (auto &domain : domains) { if (domain.activate()) return -1; } { std::ofstream out(rt_ipc_dir + "/" + rt_ipc_name + "_slaves.json"); if (!out.is_open()) { std::cerr << "could not dump json.\n"; return -1; } out << "{\n \"slaves\": "; map2Json(out, slaves, [](std::ostream &out, const ec_slave_config &slave) { slave.dumpJson(out, 8); }, 4); out << "\n}\n"; } return rtipc_prepare(rt_ipc.get()); } int ecrt_master_activate( ec_master_t *master /**< EtherCAT master. */ ) { try { return master->activate(); } catch (const std::exception &e) { std::cerr << "Could not activate: " << e.what() << '\n'; return -1; } } int ecrt_master_application_time( ec_master_t *master, /**< EtherCAT master. */ uint64_t app_time /**< Application time. */ ) { return 0; } ec_domain_t *ecrt_master_create_domain( ec_master_t *master /**< EtherCAT master. */ ) { return master->createDomain(); } static const char *getPrefix() { if (const auto ans = getenv("FAKE_EC_PREFIX")) return ans; return "/FakeEtherCAT"; } ec_domain *ec_master::createDomain() { domains.emplace_back(rt_ipc.get(), getPrefix(), this); return &domains.back(); } int ecrt_master_link_state( const ec_master_t *master, /**< EtherCAT master. */ unsigned int dev_idx, /**< Index of the device (0 = main device, 1 = first backup device, ...). */ ec_master_link_state_t *state /**< Structure to store the information. */ ) { state->slaves_responding = master->getNoSlaves(); state->al_states = 4; state->link_up = 1; return 0; } int ecrt_master_receive( ec_master_t *master /**< EtherCAT master. */ ) { return 0; } int ecrt_master_reset( ec_master_t *master /**< EtherCAT master. */ ) { return 0; } int ecrt_master_scan_progress( ec_master_t *master, /**< EtherCAT master */ ec_master_scan_progress_t *progress /**< Structure that will output the progress information. */ ) { progress->scan_index = progress->slave_count = master->getNoSlaves(); return 0; } int ecrt_master_send( ec_master_t *master /**< EtherCAT master. */ ) { return 0; } ec_slave_config_t *ecrt_master_slave_config( ec_master_t *master, /**< EtherCAT master */ uint16_t alias, /**< Slave alias. */ uint16_t position, /**< Slave position. */ uint32_t vendor_id, /**< Expected vendor ID. */ uint32_t product_code /**< Expected product code. */ ) { return master->slave_config(alias, position, vendor_id, product_code); } ec_slave_config_t *ec_master::slave_config( uint16_t alias, /**< Slave alias. */ uint16_t position, /**< Slave position. */ uint32_t vendor_id, /**< Expected vendor ID. */ uint32_t product_code /**< Expected product code. */ ) { const ec_address address{alias, position}; const auto it = slaves.find(address); if (it != slaves.end()) { if (it->second.vendor_id == vendor_id && it->second.product_code == product_code) return &it->second; else { std::cerr << "Attempted to reconfigure slave (" << alias << "," << position << ")!\n"; return nullptr; } } else { return &slaves.insert(std::make_pair(ec_address{address}, ec_slave_config{address, vendor_id, product_code})).first->second; } } int ecrt_master_state( const ec_master_t *master, /**< EtherCAT master. */ ec_master_state_t *state /**< Structure to store the information. */ ) { state->slaves_responding = master->getNoSlaves(); state->link_up = 1; state->al_states = 8; return 0; } int ecrt_master_sync_monitor_queue( ec_master_t *master /**< EtherCAT master. */ ) { return 0; } uint32_t ecrt_master_sync_monitor_process( const ec_master_t *master /**< EtherCAT master. */ ) { return 32; } int ecrt_master_sync_reference_clock( ec_master_t *master /**< EtherCAT master. */ ) { return 0; } int ecrt_master_sync_reference_clock_to( ec_master_t *master, /**< EtherCAT master. */ uint64_t sync_time /**< Sync reference clock to this time. */ ) { return 0; } int ecrt_master_sync_slave_clocks( ec_master_t *master /**< EtherCAT master. */ ) { return 0; } void ecrt_release_master(ec_master_t *master) { delete master; } ec_master_t *ecrt_request_master( unsigned int master_index /**< Index of the master to request. */ ) { return new ec_master(master_index); } static const char *getName() { if (const auto ans = getenv("FAKE_EC_NAME")) { return ans; } return "FakeEtherCAT"; } static const char *getRtIpcDir() { if (const auto ans = getenv("FAKE_EC_HOMEDIR")) { return ans; } return "/tmp/FakeEtherCAT"; } ec_master::ec_master(int id) : rt_ipc_dir(getRtIpcDir()), rt_ipc_name(getName()), rt_ipc(rtipc_create(rt_ipc_name.c_str(), rt_ipc_dir.c_str())), id_(id) { } int ecrt_slave_config_complete_sdo( ec_slave_config_t *sc, /**< Slave configuration. */ uint16_t index, /**< Index of the SDO to configure. */ const uint8_t *data, /**< Pointer to the data. */ size_t size /**< Size of the \a data. */ ) { return ecrt_slave_config_sdo(sc, index, 0, data, size); } ec_sdo_request_t *ecrt_slave_config_create_sdo_request( ec_slave_config_t *sc, /**< Slave configuration. */ uint16_t index, /**< SDO index. */ uint8_t subindex, /**< SDO subindex. */ size_t size /**< Data size to reserve. */ ) { return nullptr; } int ecrt_slave_config_dc( ec_slave_config_t *sc, /**< Slave configuration. */ uint16_t assign_activate, /**< AssignActivate word. */ uint32_t sync0_cycle, /**< SYNC0 cycle time [ns]. */ int32_t sync0_shift, /**< SYNC0 shift time [ns]. */ uint32_t sync1_cycle, /**< SYNC1 cycle time [ns]. */ int32_t sync1_shift /**< SYNC1 shift time [ns]. */ ) { return 0; } int ecrt_slave_config_idn( ec_slave_config_t *sc, /**< Slave configuration. */ uint8_t drive_no, /**< Drive number. */ uint16_t idn, /**< SoE IDN. */ ec_al_state_t state, /**< AL state in which to write the IDN (PREOP or SAFEOP). */ const uint8_t *data, /**< Pointer to the data. */ size_t size /**< Size of the \a data. */ ) { return 0; } int ecrt_slave_config_pdos( ec_slave_config_t *sc, /**< Slave configuration. */ unsigned int n_syncs, /**< Number of sync manager configurations in \a syncs. */ const ec_sync_info_t syncs[] /**< Array of sync manager configurations. */ ) { if (!syncs) return 0; for (unsigned int sync_idx = 0; sync_idx < n_syncs; ++sync_idx) { if (syncs[sync_idx].index == 0xff) { return 0; } auto &manager = sc->sync_managers[syncs[sync_idx].index]; manager.dir = syncs[sync_idx].dir; for (unsigned int i = 0; i < syncs[sync_idx].n_pdos; ++i) { const auto &in_pdo = syncs[sync_idx].pdos[i]; if (in_pdo.n_entries == 0 || !in_pdo.entries) { std::cerr << "Default mapping not supported."; return -1; } auto &out_pdo = manager.pdos[in_pdo.index]; for (unsigned int pdo_entry_idx = 0; pdo_entry_idx < in_pdo.n_entries; ++pdo_entry_idx) { out_pdo.entries.push_back(in_pdo.entries[pdo_entry_idx]); } } } return 0; } int ecrt_domain_reg_pdo_entry_list( ec_domain_t *domain, /**< Domain. */ const ec_pdo_entry_reg_t *pdo_entry_regs /**< Array of PDO registrations. */ ) { const ec_pdo_entry_reg_t *reg; ec_slave_config_t *sc; int ret; for (reg = pdo_entry_regs; reg->index; reg++) { if (!(sc = ecrt_master_slave_config(domain->getMaster(), reg->alias, reg->position, reg->vendor_id, reg->product_code))) return -ENOENT; if ((ret = ecrt_slave_config_reg_pdo_entry(sc, reg->index, reg->subindex, domain, reg->bit_position)) < 0) return ret; *reg->offset = ret; } return 0; } int ecrt_slave_config_reg_pdo_entry( ec_slave_config_t *sc, /**< Slave configuration. */ uint16_t entry_index, /**< Index of the PDO entry to register. */ uint8_t entry_subindex, /**< Subindex of the PDO entry to register. */ ec_domain_t *domain, /**< Domain. */ unsigned int *bit_position /**< Optional address if bit addressing is desired */ ) { for (auto sync_it : sc->sync_managers) { for (auto pdo_it : sync_it.second.pdos) { const auto offset = pdo_it.second.findEntry(entry_index, entry_subindex); if (offset != NotFound) { const auto domain_offset = domain->map(*sc, sync_it.first, pdo_it.first); if (domain_offset != -1) { if (bit_position) *bit_position = offset.bits; else if (offset.bits) { std::cerr << "Pdo Entry is not byte aligned but bit offset is ignored!\n"; return -1; } return domain_offset + offset.bytes; } else { return -1; } } } } return -1; // offset } int ecrt_slave_config_sdo8( ec_slave_config_t *sc, /**< Slave configuration */ uint16_t sdo_index, /**< Index of the SDO to configure. */ uint8_t sdo_subindex, /**< Subindex of the SDO to configure. */ uint8_t value /**< Value to set. */ ) { return ecrt_slave_config_sdo(sc, sdo_index, sdo_subindex, &value, 1); } int ecrt_slave_config_sdo16( ec_slave_config_t *sc, /**< Slave configuration */ uint16_t sdo_index, /**< Index of the SDO to configure. */ uint8_t sdo_subindex, /**< Subindex of the SDO to configure. */ uint16_t const value /**< Value to set. */ ) { uint8_t buf[sizeof(value)]; memcpy(&buf, &value, sizeof(value)); return ecrt_slave_config_sdo(sc, sdo_index, sdo_subindex, buf, sizeof(buf)); } int ecrt_slave_config_sdo32( ec_slave_config_t *sc, /**< Slave configuration */ uint16_t sdo_index, /**< Index of the SDO to configure. */ uint8_t sdo_subindex, /**< Subindex of the SDO to configure. */ uint32_t const value /**< Value to set. */ ) { uint8_t buf[sizeof(value)]; memcpy(&buf, &value, sizeof(value)); return ecrt_slave_config_sdo(sc, sdo_index, sdo_subindex, buf, sizeof(buf)); } int ecrt_slave_config_sdo( ec_slave_config_t *sc, /**< Slave configuration. */ uint16_t index, /**< Index of the SDO to configure. */ uint8_t subindex, /**< Subindex of the SDO to configure. */ const uint8_t *data, /**< Pointer to the data. */ size_t size /**< Size of the \a data. */ ) { sc->sdos[sdo_address{index, subindex}] = std::basic_string(data, data + size); return 0; } void ecrt_write_lreal(void *data, double const value) { memcpy(data, &value, sizeof(value)); } void ecrt_write_real(void *data, float const value) { memcpy(data, &value, sizeof(value)); } float ecrt_read_real(const void *data) { float ans; memcpy(&ans, data, sizeof(ans)); return ans; } double ecrt_read_lreal(const void *data) { double ans; memcpy(&ans, data, sizeof(ans)); return ans; } void ec_slave_config::dumpJson(std::ostream &out, int indent) const { out << "{\n"; indent += 4; add_spaces(out, indent); out << "\"vendor_id\": " << std::dec << vendor_id << ",\n"; add_spaces(out, indent); out << "\"product_id\": " << product_code << ",\n"; add_spaces(out, indent); out << "\"sdos\": "; map2Json(out, sdos, [](std::ostream &out, const std::basic_string &value) { out << "\"0x"; for (const auto s : value) { out << std::hex << std::setfill('0') << std::setw(2) << (unsigned)s; } out << '"'; }, indent); out << '\n'; add_spaces(out, indent - 4); out << "}"; }