129 #include <asm/byteorder.h>
130 #include <linux/types.h>
131 #include <linux/time.h>
135 #include <sys/time.h>
144 #define ECRT_VER_MAJOR 1
148 #define ECRT_VER_MINOR 5
152 #define ECRT_VERSION(a, b) (((a) << 8) + (b))
156 #define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)
167 #define EC_HAVE_REDUNDANCY
173 #define EC_HAVE_EMERGENCY
181 #define EC_HAVE_REG_ACCESS
185 #define EC_HAVE_SELECT_REF_CLOCK
189 #define EC_HAVE_REF_CLOCK_TIME
193 #define EC_HAVE_REG_BY_POS
197 #define EC_HAVE_SYNC_TO
201 #define EC_HAVE_FLAGS
213 #define EC_MAX_SYNC_MANAGERS 16
219 #define EC_MAX_STRING_LENGTH 64
222 #define EC_MAX_PORTS 4
232 #define EC_TIMEVAL2NANO(TV) \
233 (((TV).tv_sec - 946684800ULL) * 1000000000ULL + (TV).tv_usec * 1000ULL)
239 #define EC_COE_EMERGENCY_MSG_SIZE 8
274 unsigned int al_states : 4;
283 unsigned int link_up : 1;
298 unsigned int al_states : 4;
307 unsigned int link_up : 1;
320 unsigned int online : 1;
321 unsigned int operational : 1;
323 unsigned int al_state : 4;
343 unsigned int link_up : 1;
578 unsigned int master_index
595 unsigned int master_index
598 #endif // #ifndef __KERNEL__
627 int ecrt_master_reserve(
631 #endif // #ifndef __KERNEL__
654 void (*send_cb)(
void *),
655 void (*receive_cb)(
void *),
713 uint32_t product_code
757 uint16_t slave_position,
772 int ecrt_master_get_sync_manager(
774 uint16_t slave_position,
789 int ecrt_master_get_pdo(
791 uint16_t slave_position,
805 int ecrt_master_get_pdo_entry(
807 uint16_t slave_position,
828 uint16_t slave_position,
848 uint16_t slave_position,
866 uint16_t slave_position,
885 uint16_t slave_position,
904 uint16_t slave_position,
1020 unsigned int dev_idx,
1161 uint16_t watchdog_divider,
1166 uint16_t watchdog_intervals
1215 uint16_t entry_index,
1217 uint8_t entry_subindex,
1219 uint8_t entry_bit_length
1310 unsigned int n_syncs,
1336 uint16_t entry_index,
1337 uint8_t entry_subindex,
1339 unsigned int *bit_position
1359 unsigned int pdo_pos,
1360 unsigned int entry_pos,
1362 unsigned int *bit_position
1382 uint16_t assign_activate,
1383 uint32_t sync0_cycle,
1384 int32_t sync0_shift,
1385 uint32_t sync1_cycle,
1418 const uint8_t *data,
1435 uint8_t sdo_subindex,
1452 uint8_t sdo_subindex,
1469 uint8_t sdo_subindex,
1489 const uint8_t *data,
1643 const uint8_t *data,
1891 uint16_t vendor_type
1904 uint32_t *vendor_id,
1905 uint16_t *vendor_type
2085 #define EC_READ_BIT(DATA, POS) ((*((uint8_t *) (DATA)) >> (POS)) & 0x01)
2093 #define EC_WRITE_BIT(DATA, POS, VAL) \
2095 if (VAL) *((uint8_t *) (DATA)) |= (1 << (POS)); \
2096 else *((uint8_t *) (DATA)) &= ~(1 << (POS)); \
2105 #if __BYTE_ORDER == __LITTLE_ENDIAN
2107 #define le16_to_cpu(x) x
2108 #define le32_to_cpu(x) x
2109 #define le64_to_cpu(x) x
2111 #define cpu_to_le16(x) x
2112 #define cpu_to_le32(x) x
2113 #define cpu_to_le64(x) x
2115 #elif __BYTE_ORDER == __BIG_ENDIAN
2119 (((uint16_t)(x) & 0x00ffU) << 8) | \
2120 (((uint16_t)(x) & 0xff00U) >> 8) ))
2123 (((uint32_t)(x) & 0x000000ffUL) << 24) | \
2124 (((uint32_t)(x) & 0x0000ff00UL) << 8) | \
2125 (((uint32_t)(x) & 0x00ff0000UL) >> 8) | \
2126 (((uint32_t)(x) & 0xff000000UL) >> 24) ))
2129 (((uint64_t)(x) & 0x00000000000000ffULL) << 56) | \
2130 (((uint64_t)(x) & 0x000000000000ff00ULL) << 40) | \
2131 (((uint64_t)(x) & 0x0000000000ff0000ULL) << 24) | \
2132 (((uint64_t)(x) & 0x00000000ff000000ULL) << 8) | \
2133 (((uint64_t)(x) & 0x000000ff00000000ULL) >> 8) | \
2134 (((uint64_t)(x) & 0x0000ff0000000000ULL) >> 24) | \
2135 (((uint64_t)(x) & 0x00ff000000000000ULL) >> 40) | \
2136 (((uint64_t)(x) & 0xff00000000000000ULL) >> 56) ))
2138 #define le16_to_cpu(x) swap16(x)
2139 #define le32_to_cpu(x) swap32(x)
2140 #define le64_to_cpu(x) swap64(x)
2142 #define cpu_to_le16(x) swap16(x)
2143 #define cpu_to_le32(x) swap32(x)
2144 #define cpu_to_le64(x) swap64(x)
2148 #define le16_to_cpup(x) le16_to_cpu(*((uint16_t *)(x)))
2149 #define le32_to_cpup(x) le32_to_cpu(*((uint32_t *)(x)))
2150 #define le64_to_cpup(x) le64_to_cpu(*((uint64_t *)(x)))
2162 #define EC_READ_U8(DATA) \
2163 ((uint8_t) *((uint8_t *) (DATA)))
2170 #define EC_READ_S8(DATA) \
2171 ((int8_t) *((uint8_t *) (DATA)))
2178 #define EC_READ_U16(DATA) \
2179 ((uint16_t) le16_to_cpup((void *) (DATA)))
2186 #define EC_READ_S16(DATA) \
2187 ((int16_t) le16_to_cpup((void *) (DATA)))
2194 #define EC_READ_U32(DATA) \
2195 ((uint32_t) le32_to_cpup((void *) (DATA)))
2202 #define EC_READ_S32(DATA) \
2203 ((int32_t) le32_to_cpup((void *) (DATA)))
2210 #define EC_READ_U64(DATA) \
2211 ((uint64_t) le64_to_cpup((void *) (DATA)))
2218 #define EC_READ_S64(DATA) \
2219 ((int64_t) le64_to_cpup((void *) (DATA)))
2232 float ecrt_read_real(
const void *data);
2239 #define EC_READ_REAL(DATA) ecrt_read_real(DATA)
2246 double ecrt_read_lreal(
const void *data);
2253 #define EC_READ_LREAL(DATA) ecrt_read_lreal(DATA)
2255 #endif // ifndef __KERNEL__
2266 #define EC_WRITE_U8(DATA, VAL) \
2268 *((uint8_t *)(DATA)) = ((uint8_t) (VAL)); \
2276 #define EC_WRITE_S8(DATA, VAL) EC_WRITE_U8(DATA, VAL)
2283 #define EC_WRITE_U16(DATA, VAL) \
2285 *((uint16_t *) (DATA)) = cpu_to_le16((uint16_t) (VAL)); \
2293 #define EC_WRITE_S16(DATA, VAL) EC_WRITE_U16(DATA, VAL)
2300 #define EC_WRITE_U32(DATA, VAL) \
2302 *((uint32_t *) (DATA)) = cpu_to_le32((uint32_t) (VAL)); \
2310 #define EC_WRITE_S32(DATA, VAL) EC_WRITE_U32(DATA, VAL)
2317 #define EC_WRITE_U64(DATA, VAL) \
2319 *((uint64_t *) (DATA)) = cpu_to_le64((uint64_t) (VAL)); \
2327 #define EC_WRITE_S64(DATA, VAL) EC_WRITE_U64(DATA, VAL)
2340 void ecrt_write_real(
void *data,
float value);
2347 #define EC_WRITE_REAL(DATA, VAL) ecrt_write_real(DATA, VAL)
2354 void ecrt_write_lreal(
void *data,
double value);
2361 #define EC_WRITE_LREAL(DATA, VAL) ecrt_write_lreal(DATA, VAL)
2363 #endif // ifndef __KERNEL__
unsigned int working_counter
Value of the last working counter.
size_t ecrt_domain_size(const ec_domain_t *domain)
Returns the current size of the domain's process data.
void ecrt_reg_request_write(ec_reg_request_t *req, uint16_t address, size_t size)
Schedule an register write operation.
uint32_t serial_number
Serial-Number stored on the slave.
ec_slave_port_desc_t desc
Physical port type.
uint8_t subindex
PDO entry subindex.
uint16_t position
Slave position.
int ecrt_slave_config_emerg_size(ec_slave_config_t *sc, size_t elements)
Set the size of the CoE emergency ring buffer.
uint32_t ecrt_master_sync_monitor_process(ec_master_t *master)
Processes the DC synchrony monitoring datagram.
void ecrt_voe_handler_received_header(const ec_voe_handler_t *voe, uint32_t *vendor_id, uint16_t *vendor_type)
Reads the header data of a received VoE message.
void ecrt_reg_request_read(ec_reg_request_t *req, uint16_t address, size_t size)
Schedule a register read operation.
size_t ecrt_voe_handler_data_size(const ec_voe_handler_t *voe)
Returns the current data size.
void ecrt_release_master(ec_master_t *master)
Releases a requested EtherCAT master.
uint8_t sync_count
Number of sync managers.
unsigned int n_entries
Number of PDO entries in entries to map.
uint8_t bit_length
Size of the PDO entry in bit.
ec_direction_t dir
Sync manager direction.
uint8_t error_flag
Error flag for that slave.
ec_watchdog_mode_t
Watchdog mode for sync manager configuration.
void ecrt_master_sync_slave_clocks(ec_master_t *master)
Queues the DC clock drift compensation datagram for sending.
ec_slave_port_desc_t
EtherCAT slave port descriptor.
int ecrt_slave_config_sdo(ec_slave_config_t *sc, uint16_t index, uint8_t subindex, const uint8_t *data, size_t size)
Add an SDO configuration.
ec_al_state_t
Application-layer state.
ec_pdo_info_t * pdos
Array with PDOs to assign.
int ecrt_slave_config_pdo_assign_add(ec_slave_config_t *sc, uint8_t sync_index, uint16_t index)
Add a PDO to a sync manager's PDO assignment.
int ecrt_master_link_state(const ec_master_t *master, unsigned int dev_idx, ec_master_link_state_t *state)
Reads the current state of a redundant link.
void ecrt_master_application_time(ec_master_t *master, uint64_t app_time)
Sets the application time.
unsigned int redundancy_active
Redundant link is in use.
unsigned int slave_count
Number of slaves in the bus.
uint16_t index
PDO entry index.
uint32_t vendor_id
Vendor-ID stored on the slave.
int ecrt_master_sdo_download_complete(ec_master_t *master, uint16_t slave_position, uint16_t index, uint8_t *data, size_t data_size, uint32_t *abort_code)
Executes an SDO download request to write data to a slave via complete access.
ec_slave_port_link_t link
Port link state.
unsigned int slaves_responding
Sum of responding slaves on the given link.
int ecrt_domain_reg_pdo_entry_list(ec_domain_t *domain, const ec_pdo_entry_reg_t *pdo_entry_regs)
Registers a bunch of PDO entries for a domain.
void ecrt_master_callbacks(ec_master_t *master, void(*send_cb)(void *), void(*receive_cb)(void *), void *cb_data)
Sets the locking callbacks.
int ecrt_master_get_slave(ec_master_t *master, uint16_t slave_position, ec_slave_info_t *slave_info)
Obtains slave information.
int ecrt_slave_config_reg_pdo_entry_pos(ec_slave_config_t *sc, uint8_t sync_index, unsigned int pdo_pos, unsigned int entry_pos, ec_domain_t *domain, unsigned int *bit_position)
Registers a PDO entry using its position.
uint32_t delay_to_next_dc
Delay [ns] to next DC slave.
void ecrt_master_send_ext(ec_master_t *master)
Sends non-application datagrams.
ec_wc_state_t wc_state
Working counter interpretation.
PDO configuration information.
ec_domain_t * ecrt_master_create_domain(ec_master_t *master)
Creates a new process data domain.
void ecrt_voe_handler_read(ec_voe_handler_t *voe)
Start a VoE read operation.
Sync manager configuration information.
ec_wc_state_t
Domain working counter interpretation.
uint8_t signal_detected
Detected signal on RX port.
EtherCAT slave port information.
unsigned int slaves_responding
Sum of responding slaves on all Ethernet devices.
void ecrt_master_state(const ec_master_t *master, ec_master_state_t *state)
Reads the current master state.
void ecrt_voe_handler_read_nosync(ec_voe_handler_t *voe)
Start a VoE read operation without querying the sync manager status.
int ecrt_slave_config_emerg_clear(ec_slave_config_t *sc)
Clears CoE emergency ring buffer and the overrun counter.
void ecrt_domain_external_memory(ec_domain_t *domain, uint8_t *memory)
Provide external memory to store the domain's process data.
void ecrt_master_sync_reference_clock_to(ec_master_t *master, uint64_t sync_time)
Queues the DC reference clock drift compensation datagram for sending.
void ecrt_sdo_request_timeout(ec_sdo_request_t *req, uint32_t timeout)
Set the timeout for an SDO request.
ec_voe_handler_t * ecrt_slave_config_create_voe_handler(ec_slave_config_t *sc, size_t size)
Create an VoE handler to exchange vendor-specific data during realtime operation. ...
int ecrt_slave_config_flag(ec_slave_config_t *sc, const char *key, int32_t value)
Adds a feature flag to a slave configuration.
void ecrt_slave_config_dc(ec_slave_config_t *sc, uint16_t assign_activate, uint32_t sync0_cycle, int32_t sync0_shift, uint32_t sync1_cycle, int32_t sync1_shift)
Configure distributed clocks.
int ecrt_slave_config_sdo16(ec_slave_config_t *sc, uint16_t sdo_index, uint8_t sdo_subindex, uint16_t value)
Add a configuration value for a 16-bit SDO.
Some of the registered process data were exchanged.
uint32_t revision_number
Revision-Number stored on the slave.
uint8_t * ecrt_sdo_request_data(ec_sdo_request_t *req)
Access to the SDO request's data.
Use the default setting of the sync manager.
uint16_t alias
Slave alias address.
uint8_t loop_closed
Loop closed.
void ecrt_sdo_request_read(ec_sdo_request_t *req)
Schedule an SDO read operation.
ec_master_t * ecrt_request_master(unsigned int master_index)
Requests an EtherCAT master for realtime operation.
int ecrt_slave_config_complete_sdo(ec_slave_config_t *sc, uint16_t index, const uint8_t *data, size_t size)
Add configuration data for a complete SDO.
Slave configuration state.
Request is being processed.
uint64_t app_time
Application time.
ec_watchdog_mode_t watchdog_mode
Watchdog mode.
unsigned int n_pdos
Number of PDOs in pdos.
uint32_t vendor_id
Slave vendor ID.
unsigned int * bit_position
Pointer to a variable to store a bit position (0-7) within the offset.
int ecrt_master_sdo_download(ec_master_t *master, uint16_t slave_position, uint16_t index, uint8_t subindex, uint8_t *data, size_t data_size, uint32_t *abort_code)
Executes an SDO download request to write data to a slave.
int ecrt_master_select_reference_clock(ec_master_t *master, ec_slave_config_t *sc)
Selects the reference clock for distributed clocks.
ec_reg_request_t * ecrt_slave_config_create_reg_request(ec_slave_config_t *sc, size_t size)
Create a register request to exchange EtherCAT register contents during realtime operation.
ec_direction_t
Direction type for PDO assignment functions.
int ecrt_master_set_send_interval(ec_master_t *master, size_t send_interval)
Set interval between calls to ecrt_master_send().
unsigned int ecrt_version_magic(void)
Returns the version magic of the realtime interface.
Vendor specific over EtherCAT handler.
ec_request_state_t ecrt_voe_handler_execute(ec_voe_handler_t *voe)
Execute the handler.
int ecrt_slave_config_sdo32(ec_slave_config_t *sc, uint16_t sdo_index, uint8_t sdo_subindex, uint32_t value)
Add a configuration value for a 32-bit SDO.
int ecrt_master_sdo_upload(ec_master_t *master, uint16_t slave_position, uint16_t index, uint8_t subindex, uint8_t *target, size_t target_size, size_t *result_size, uint32_t *abort_code)
Executes an SDO upload request to read data from a slave.
Values read by the master.
ec_request_state_t ecrt_sdo_request_state(const ec_sdo_request_t *req)
Get the current state of the SDO request.
int ecrt_slave_config_idn(ec_slave_config_t *sc, uint8_t drive_no, uint16_t idn, ec_al_state_t state, const uint8_t *data, size_t size)
Add an SoE IDN configuration.
void ecrt_master_reset(ec_master_t *master)
Retry configuring slaves.
void ecrt_master_sync_monitor_queue(ec_master_t *master)
Queues the DC synchrony monitoring datagram for sending.
void ecrt_voe_handler_write(ec_voe_handler_t *voe, size_t size)
Start a VoE write operation.
int ecrt_slave_config_sdo8(ec_slave_config_t *sc, uint16_t sdo_index, uint8_t sdo_subindex, uint8_t value)
Add a configuration value for an 8-bit SDO.
int ecrt_slave_config_pdo_mapping_add(ec_slave_config_t *sc, uint16_t pdo_index, uint16_t entry_index, uint8_t entry_subindex, uint8_t entry_bit_length)
Add a PDO entry to the given PDO's mapping.
int ecrt_slave_config_reg_pdo_entry(ec_slave_config_t *sc, uint16_t entry_index, uint8_t entry_subindex, ec_domain_t *domain, unsigned int *bit_position)
Registers a PDO entry for process data exchange in a domain.
uint16_t index
PDO entry index.
uint8_t al_state
Current state of the slave.
ec_slave_config_t * ecrt_master_slave_config(ec_master_t *master, uint16_t alias, uint16_t position, uint32_t vendor_id, uint32_t product_code)
Obtains a slave configuration.
uint8_t scan_busy
true, while the master is scanning the bus
int ecrt_slave_config_pdos(ec_slave_config_t *sc, unsigned int n_syncs, const ec_sync_info_t syncs[])
Specify a complete PDO configuration.
int ecrt_master_read_idn(ec_master_t *master, uint16_t slave_position, uint8_t drive_no, uint16_t idn, uint8_t *target, size_t target_size, size_t *result_size, uint16_t *error_code)
Executes an SoE read request.
int ecrt_master_activate(ec_master_t *master)
Finishes the configuration phase and prepares for cyclic operation.
int16_t current_on_ebus
Used current in mA.
size_t ecrt_sdo_request_data_size(const ec_sdo_request_t *req)
Returns the current SDO data size.
void ecrt_slave_config_pdo_mapping_clear(ec_slave_config_t *sc, uint16_t pdo_index)
Clear the mapping of a given PDO.
#define EC_MAX_PORTS
Maximum number of slave ports.
uint16_t sdo_count
Number of SDOs.
#define EC_MAX_STRING_LENGTH
Maximum string length.
uint8_t * ecrt_domain_data(ec_domain_t *domain)
Returns the domain's process data.
List record type for PDO entry mass-registration.
uint16_t next_slave
Ring position of next DC slave on that port.
No registered process data were exchanged.
All registered process data were exchanged.
void ecrt_slave_config_watchdog(ec_slave_config_t *sc, uint16_t watchdog_divider, uint16_t watchdog_intervals)
Configure a slave's watchdog times.
void ecrt_master_deactivate(ec_master_t *master)
Deactivates the master.
int ecrt_slave_config_sync_manager(ec_slave_config_t *sc, uint8_t sync_index, ec_direction_t direction, ec_watchdog_mode_t watchdog_mode)
Configure a sync manager.
uint16_t alias
The slaves alias if not equal to 0.
int ecrt_master(ec_master_t *master, ec_master_info_t *master_info)
Obtains master information.
int ecrt_master_write_idn(ec_master_t *master, uint16_t slave_position, uint8_t drive_no, uint16_t idn, uint8_t *data, size_t data_size, uint16_t *error_code)
Executes an SoE write request.
EtherCAT slave configuration.
uint32_t product_code
Product-Code stored on the slave.
void ecrt_voe_handler_send_header(ec_voe_handler_t *voe, uint32_t vendor_id, uint16_t vendor_type)
Sets the VoE header for future send operations.
Request was processed successfully.
unsigned int * offset
Pointer to a variable to store the PDO entry's (byte-)offset in the process data. ...
ec_request_state_t
Request state.
uint8_t * ecrt_reg_request_data(ec_reg_request_t *req)
Access to the register request's data.
int ecrt_master_reference_clock_time(ec_master_t *master, uint32_t *time)
Get the lower 32 bit of the reference clock system time.
void ecrt_domain_state(const ec_domain_t *domain, ec_domain_state_t *state)
Reads the state of a domain.
PDO entry configuration information.
int ecrt_slave_config_emerg_pop(ec_slave_config_t *sc, uint8_t *target)
Read and remove one record from the CoE emergency ring buffer.
void ecrt_slave_config_pdo_assign_clear(ec_slave_config_t *sc, uint8_t sync_index)
Clear a sync manager's PDO assignment.
void ecrt_domain_process(ec_domain_t *domain)
Determines the states of the domain's datagrams.
uint8_t index
Sync manager index.
void ecrt_slave_config_state(const ec_slave_config_t *sc, ec_slave_config_state_t *state)
Outputs the state of the slave configuration.
Values written by the master.
void ecrt_domain_queue(ec_domain_t *domain)
(Re-)queues all domain datagrams in the master's datagram queue.
uint16_t position
Offset of the slave in the ring.
uint32_t receive_time
Receive time on DC transmission delay measurement.
uint32_t product_code
Slave product code.
Request processing failed.
void ecrt_master_sync_reference_clock(ec_master_t *master)
Queues the DC reference clock drift compensation datagram for sending.
uint8_t link_up
Link detected.
uint8_t subindex
PDO entry subindex.
ec_sdo_request_t * ecrt_slave_config_create_sdo_request(ec_slave_config_t *sc, uint16_t index, uint8_t subindex, size_t size)
Create an SDO request to exchange SDOs during realtime operation.
uint8_t * ecrt_voe_handler_data(ec_voe_handler_t *voe)
Access to the VoE handler's data.
void ecrt_sdo_request_write(ec_sdo_request_t *req)
Schedule an SDO write operation.
int ecrt_slave_config_emerg_overruns(ec_slave_config_t *sc)
Read the number of CoE emergency overruns.
ec_request_state_t ecrt_reg_request_state(const ec_reg_request_t *req)
Get the current state of the register request.
void ecrt_sdo_request_index(ec_sdo_request_t *req, uint16_t index, uint8_t subindex)
Set the SDO index and subindex.
ec_pdo_entry_info_t * entries
Array of PDO entries to map.
void ecrt_master_receive(ec_master_t *master)
Fetches received frames from the hardware and processes the datagrams.
void ecrt_master_send(ec_master_t *master)
Sends all datagrams in the queue.