1

-------------------------------------------------------------------------------

     2

     3

$Id$

     4

     5

vim: spelllang=en spell

     6

     7

-------------------------------------------------------------------------------

     8

     9

Changes since 1.5:

    10

    11

* Added e1000e driver for 2.3.32, 2.6.33, 2.6.34 (thanks to Siwei Zhuang) and

    12

  2.6.37.

    14

    15

Changes in 1.5:

    16

    17

* Added a userspace library for accessing the application interface. This

    18

  library is licensed under LGPLv2.

    19

* Added distributed clocks support.

    20

* Added watchdog configuration via application interface (thanks to J. Mohre).

    21

* Added VoE mailbox protocol support.

    22

* Added SoE mailbox protocol support.

    23

* Improved the callback mechanism. ecrt_master_callbacks() now takes two

    24

  callback functions for sending and receiving datagrams.

    25

  ecrt_master_send_ext() is used to execute the sending of non-application

    26

  datagrams.

    27

* Separated datagram initialization from filling the payload with zeros.

    28

  Introduced new method ec_datagram_zero() for that.

    29

* Added phy_read and phy_write commands to ethercat tool.

    30

* Added e100 driver for Intel PRO/100 NICs for 2.6.27, 2.6.28 (thanks to

    31

  Kim. H. Madsen), 2.6.29 (thanks to Andre Puschmann), 2.6.31, 2.6.32, 2.6.33

    32

  and 2.6.37.

    33

* Added 8139too driver for kernels 2.6.25 (F. Pose), 2.6.26 (M. Luescher),

    34

  2.6.27, 2.6.28, 2.6.29 (M. Goetze), 2.6.31 (F. Pose), 2.6.34 (Malcolm

    35

  Lewis), 2.6.36 (F. Pose) and 2.6.37 (F. Pose).

    36

* Added e1000 driver for 2.6.26 (M. Luescher), 2.6.27, 2.6.28, 2.6.29, 2.6.31,

    37

  2.6.32, 2.6.33 and 2.6.37.

    38

* Added r8169 driver for 2.6.24, 2.6.27, 2.6.28, 2.6.29, 2.6.31, 2.6.32

    39

  (latter thanks to Robbie K), 2.6.33 and 2.6.37.

    40

* Debug interfaces are created with the Ethernet addresses of the attached

    41

  physical device.

    42

* Improved error case return codes of many functions.

    43

* Implemented the File Access over EtherCAT (FoE) mailbox protocol, thanks to

    44

  O. Zarges.

    45

* Going to the Bootstrap state is now supported by the state machines and the

    46

  command-line tool.

    47

* Added ecrt_open_master() and ecrt_master_reserve() separation for

    48

  the userspace library (thanks to Martin Troxler).

    49

* Added bus information interface (methods ecrt_master(),

    50

  ecrt_master_get_slave(), ecrt_master_get_sync_manager(),

    51

  ecrt_master_get_pdo() and ecrt_master_get_pdo_entry()) to get information

    52

  about the currently connected slaves and the PDO entries provided (thanks to

    53

  Martin Troxler and Stefan Weiser).

    54

* Added ecrt_master_sdo_download() and ecrt_master_sdo_upload()

    55

  methods to let an application transfer SDOs before activating the master

    56

  (thanks to Stefan Weiser).

    57

* Fixed SDO upload segment response (thanks to Christoph Peter).

    58

* Fixed SDO upload segment response for 10 bytes mailbox length (thanks to

    59

  Joerg Mohre).

    60

* SDO entry access rights are shown in 'ethercat sdos'.

    61

* Added 64-bit data access macros to application header.

    62

* Added debug level for all masters as a module parameter. Thanks to Erwin

    63

  Burgstaller.

    64

* Clear slave list on link down.

    65

* Output device link state in 'ethercat master'.

    66

* Added 'ethercat graph' command which outputs the bus topology in

    67

  DOT language.

    68

* Changed EC_MAX_SII_SIZE to 4096.

    69

* 'ethercat xml' creates valid XML <EtherCATInfoList> for more than one slave

    70

  (thanks to E. Burgstaller).

    71

* Added 'ethercat eoe' command to display Ethernet over EtherCAT statistics.

    72

* Added 'ethercat cstruct' command to output PDO information in C language.

    73

* Significantly improved EoE bandwidth by running EoE processing in a kthread.

    74

* Switched version control from Subversion to Mercurial.

    75

* Implemented CompleteAccess for SDO downloads.

    76

* ethercat tool is now able to handle multiple masters. The --masters option

    77

  supports ranges like '0,3,8-10'.

    78

* A sync manager is always enabled, if it contains registered process data.

    79

* Added a configuration switch --enable-wildcards to use 0xffffffff as a

    80

* wildcard for vendor ID and product code.

    81

* Added support for systemd.

    82

    83

Changes in 1.4.0:

    84

    85

* Fixed race condition in jiffy-based frame timeout calculation.

    86

* Fixed race condition concerning the ec_slave_config_state->operational flag.

    87

* Fixed wrong calculation of the expected working counter if the process data

    88

  of a domain span several datagrams.

    89

* Fixed a kernel oops when a slave configuration is detached while the actual

    90

  configuration is in progress.

    91

* Fixed typo in logging output.

    92

* Removed 'bashisms' from init script ('function' keyword).

    93

* Fixed bug in e1000 drivers. Memory was allocated when sending the first

    94

  frame.

    95

* Modified licence headers to avoid conflicts with the GPL.

    96

* Restricted licence to GPLv2 only.

    97

* Fixed spelling of 'PDO', 'SDO' (all uppercase) and 'xx over EtherCAT'

    98

  (without hyphens).

    99

   100

Changes in 1.4.0-rc3:

   101

   102

* Ported the master thread to the kthread interface.

   103

* Added missing semaphore up() in an ioctl(). In rare cases, the master

   104

  semaphore was not released.

   105

* Minor fix in 'slaves' command that fixed duplicate display of supported

   106

  mailbox protocols.

   107

* The SDO Information Service is only queried, if the slave has the

   108

  corresponding SII bit set.

   109

* Added some missing header files in the command-line-tool code.

   110

* Removed unstable e100, forcedeth, and r8169 drivers.

   111

   112

Changes in version 1.4.0-rc2:

   113

   114

* Fixed a deadlock causing race condition concerning thread signaling when the

   115

  master thread had no opportunity to run, but shall be killed immediately

   116

  after creation.

   117

* Added missing up()s causing a semaphore being not released in some rare

   118

  cases.

   119

* Minor fixes.

   120

* Removed some deprecated files.

   121

   122

Changes in version 1.4.0-rc1:

   123

   124

* Realtime interface changes:

   125

    - Replaced ec_slave_t with ec_slave_config_t, separating the bus

   126

      configuration from the actual slaves. Therefore, renamed

   127

      ecrt_master_get_slave() to ecrt_master_slave_config().

   128

    - Replaced slave address string with alias and position values. See

   129

      ecrt_master_slave_config().

   130

    - Removed ecrt_master_get_slave_by_pos(), because it is no longer

   131

      necessary due to alias/position addressing.

   132

    - Added ec_slave_config_state_t for the new method

   133

      ecrt_slave_config_state().

   134

    - Process data memory for a domain can now be allocated externally. This

   135

      offers the possibility to use a shared-memory region. Therefore,

   136

      added the domain methods ecrt_domain_size() and

   137

      ecrt_domain_external_memory().

   138

    - PDO entry registration functions do not return a process data pointer,

   139

      but an offset in the domain's process data. In addition, an optional bit

   140

      position can be requested. This was necessary for the external domain

   141

      memory. An additional advantage is, that the returned offset is

   142

      immediately valid. If the domain's process data is allocated internally,

   143

      the start address can be retrieved with ecrt_domain_data().

   144

    - Replaced ecrt_slave_pdo_mapping/add/clear() with

   145

      ecrt_slave_config_pdo_assign_add() to add a PDO to a sync manager's PDO

   146

      assignment and ecrt_slave_config_pdo_mapping_add() to add a PDO entry to a

   147

      PDO's mapping. ecrt_slave_config_pdos() is a convenience function

   148

      for both, that uses the new data types ec_pdo_info_t and

   149

      ec_pdo_entry_info_t. PDO entries, that are mapped with these functions

   150

      can now immediately be registered, even if the bus is offline.

   151

    - Renamed ec_bus_status_t, ec_master_status_t to ec_bus_state_t and

   152

      ec_master_state_t, respectively. Renamed ecrt_master_get_status() to

   153

      ecrt_master_state(), for consistency reasons.

   154

    - Added ec_domain_state_t and ec_wc_state_t for a new output parameter

   155

      of ecrt_domain_state(). The domain state object does now contain

   156

      information, if the process data was exchanged completely.

   157

    - Former "PDO registration" meant PDO entry registration in fact, therefore

   158

      renamed ec_pdo_reg_t to ec_pdo_entry_reg_t and ecrt_domain_register_pdo()

   159

      to ecrt_slave_config_reg_pdo_entry().

   160

    - Removed ecrt_domain_register_pdo_range(), because it's functionality can

   161

      be reached by specifying an explicit PDO assignment/mapping and

   162

      registering the mapped PDO entries.

   163

    - Added an SDO access interface, working with SDO requests. These can be

   164

      scheduled for reading and writing during realtime operation.

   165

    - Exported ecrt_slave_config_sdo(), the generic SDO configuration function.

   166

    - Removed the bus_state and bus_tainted flags from ec_master_state_t.

   167

* Device interface changes:

   168

    - Moved device output parameter of ecdev_offer() to return value.

   169

* Replaced the Sysfs interface with a new 'ethercat' command-line tool, that

   170

  communicates with the master via a character device and ioctls. The device

   171

  is created via udev. The tool is able to

   172

    - Write alias addresses.

   173

    - Show the bus configuration.

   174

    - Output binary domain process data.

   175

    - Set the master's debug level.

   176

    - Show domain information.

   177

    - Show master information.

   178

    - List PDO assignment/mapping.

   179

    - Write an SDO entry.

   180

    - List SDO dictionaries.

   181

    - Read an SDO entry.

   182

    - Output a slave's SII contents.

   183

    - Write slave's SII contents.

   184

    - Show slaves.

   185

    - Request slave states.

   186

    - Generate slave information xmls.

   187

* Removed include/ecdb.h.

   188

* Using the timestamp counter is now optional (configure --enable-cycles),

   189

  because it is only available on Intel architectures.

   190

* SDO dictionaries will now also be fetched in operation mode.

   191

* SII write requests will now also be processed in operation mode.

   192

* Mapping of PDO entries is now supported.

   193

* Current PDO assignment/mapping is now read via CoE during bus scan, using

   194

  direct SDO access, independent of the dictionary.

   195

* Network driver news:

   196

    - Added 8139too driver for kernel 2.6.22, thanks to Erwin Burgstaller.

   197

    - Added 8139too driver for kernel 2.6.23, thanks to Richard Hacker.

   198

    - Added 8139too driver for kernel 2.6.24.

   199

    - Added e1000 driver for kernel 2.6.22.

   200

    - Added e1000 driver for kernel 2.6.24, thanks to Matthias Luescher.

   201

    - Added alpha support for the Realtek r8169 chipset, thanks to Scott

   202

      Hassan.

   203

    - Fixed unnecessary watchdog executions in e1000 drivers (thanks to

   204

      Olav Zarges).

   205

    - Fixed missing protection for a spin_lock_irqrestore() call in e1000

   206

      drivers from 2.6.20 to 2.6.24 (thanks to Olav Zarges).

   207

* Removed the "bus validation" routines. Slave scanning is now done any time

   208

  the bus topology changes, even during realtime operation. Because of this,

   209

  the bus_tainted flag was deprecated and removed.

   210

* Slave configuration is not done during ecrt_master_activate() any more, but

   211

  later during realtime operation. The state of the configuration can be

   212

  queried via the ecrt_domain_state() and ecrt_slave_config_state() functions.

   213

* Added support for slaves that do not support the LRW datagram type. Separate

   214

  domains have to be used for inputs and output.

   215

* CoE implementation:

   216

    - Use expedites transfer type for SDOs <= 4 byte (thanks to J. Mohre).

   217

    - Allow gaps in PDO mapping (thanks to R. Roesch).

   218

    - Added some transfer timeouts.

   219

    - Asynchronous handling of Emergency requests.

   220

    - Bug fixes.

   221

* Sync managers are disabled, if the size is zero.

   222

* Renamed ec_master module parameters main and backup to main_devices and

   223

  backup_devices to avoid warnings of some compilers.

   224

* List end evaluate CoE detail flags from general category.

   225

* Added MODPROBE_FLAGS variable in start script and sysconfig file.

   226

* Implemented missing datagram types.

   227

* Changed all occurrences of 'EEPROM' to 'SII'

   228

* Allow multiple sync manager categories in SII.

   229

   230

-------------------------------------------------------------------------------

   231

   232

Changes in version 1.3.2:

   233

   234

* New feature: Read dynamic PDO mapping from SDO dictionary.

   235

* Implemented SII writing workaround for some broken slaves.

   236

* Improved handling for spontaneous AL state changes.

   237

* Master takes mailbox sync manager configurations from EEPROM words

   238

  0x0018-0x001b, if no sync manager configurations are provided.

   239

* Calculate checksum when writing EEPROM or alias address.

   240

* Fixed source MAC address setting bug.

   241

* Removed config.kbuild and replaced Kbuild files by Kbuild.in files.

   242

   243

-------------------------------------------------------------------------------

   244

   245

Changes in version 1.3.1:

   246

   247

* Improved EoE handling: Avoided skipping of datagrams and release lock

   248

  while processing.

   249

* Added some statistics to the datagram structure.

   250

* Master state machine clears all station addresses with a broadcast datagram

   251

  before setting them.

   252

* Added --enable-eoe conditional.

   253

* Minor extensions of the master info file.

   254

* Improved handling of unexpected working counters.

   255

* Create network interfaces for EoE devices with alias as eoeXaY.

   256

* Fixed problems on big-endian systems.

   257

* Added documentation on how to set up an EoE network.

   258

   259

-------------------------------------------------------------------------------

   260

   261

Changes in version 1.3.0:

   262

   263

* Added Intel PRO/1000 Gigabit Ethernet driver (e1000).

   264

* Added testing version of Intel PRO/100 Ethernet driver (e100).

   265

* Added testing version of NVIDIA nForce Ethernet driver (forcedeth).

   266

* Removed "ec_eoeif_count" master module parameter. EoE handlers are created

   267

  dynamically instead.

   268

* Added "main" and "backup" parameters to master module to hand over the

   269

  MAC addresses of the devices to wait for. This made the ec_device_index

   270

  parameter of the Ethernet drivers obsolete. The broadcast MAC address means,

   271

  that the master accepts the first device offered by any Ethernet driver.

   272

* Changed format of sysconfig file and accordingly adjusted functionality

   273

  of the init script to handle the above MAC address lists.

   274

* Realtime interface changes:

   275

  - ecrt_master_run() became obsolete, because the master state machine is now

   276

    run in process context.

   277

  - Parameter changes in PDO registration functions ecrt_domain_register_pdo()

   278

    and ecrt_register_pdo_range(): Replaced slave_address, vendor ID and

   279

    product code arguments with a slave pointer, which has to be obtained with

   280

    a prior call to ecrt_master_get_slave().

   281

  - ecrt_master_get_slave() got additional parameters to check for vendor ID

   282

    and product code.

   283

  - Removed addressing scheme "X:Y" for ecrt_master_get_slave().

   284

  - Added ecrt_master_get_slave_by_pos() to avoid the string handling of

   285

    ecrt_master_get_slave().

   286

  - Added ecrt_master_get_status() to get status information about the bus.

   287

  - Added functions to set up an alternative PDO mapping for a slave, i. e.

   288

    ec_slave_pdo_mapping_clear(), ec_slave_pdo_mapping_add() and

   289

    ec_slave_pdo_mapping().

   290

* Device interface changes:

   291

  - Replaced ecdev_register() and ecdev_unregister() with ecdev_offer() and

   292

    ecdev_withdraw(), respectively. The device modules now offer all their

   293

    devices to the master. The master then decides, which ones to register.

   294

  - Replaced ecdev_link_state() with ecdev_set_link(); added ecdev_get_link().

   295

* All EEPROM write operations from user space are now blocking until

   296

  writing has finished. Appropriate error codes are returned.

   297

* Implemented setting of the "Secondary slave address" (alias) via sysfs.

   298

* Implemented SDO reading in operation mode via sysfs.

   299

* Removed annoying eeprom_write_enable file. EEPROM writing always enabled.

   300

* Slave configuration is now done exclusively from the master thread. Removed

   301

  ec_master_sync_io(). Userspace threads are now waiting for events in the

   302

  state machine.

   303

* Master state machine scheduled with timeout if idle, otherwise is executed

   304

  as fast as possible (with schedule()).

   305

* Added dummy module for simulation purposes.

   306

* Limited infinite EEPROM reading, if 0xffff limiter word is missing.

   307

* Init script works now properly on non-SUSE distros (no rc.status dependency

   308

  any more).

   309

* Removed EtherCAT line comments from 8139too drivers.

   310

   311

-------------------------------------------------------------------------------

   312

   313

Changes in version 1.2.0:

   314

   315

* Several fixes of bugs and stability issues. Master should now run fine

   316

  with kernels 2.6.17 to 2.6.19.

   317

* Realtime interface changes:

   318

  - Re-introduced ecrt_domain_queue() to allow datagram queuing apart

   319

    from datagram processing. The queuing of a domain's datagrams is not

   320

    done in ecrt_domain_process() any more!

   321

  - Removed ecrt_master_deactivate(). Its functionality was moved into

   322

    ecrt_master_release().

   323

  - Removed ecrt_master_prepare(). Its functionality was moved into

   324

    ecrt_master_activate().

   325

  - Renamed ecdev_start() and ecdev_stop() to ecdev_open() and ecdev_close().

   326

    These two functions now take a pointer to ec_device_t as their arguments.

   327

  - The data_ptr parameter of ecrt_domain_register_pdo(),

   328

    ecrt_domain_register_pdo_list() and ecrt_domain_register_pdo_range() may

   329

    not be NULL any more.

   330

  - Removed ecrt_slave_pdo_size(). This function was deprecated long before.

   331

  - Introduced ECRT_VERSION_MAGIC macro and ecrt_version_magic() function.

   332

* Device interface changes:

   333

  - ec_isr_t was replaced by ec_pollfunc_t, the device driver has to supply

   334

    a poll function to call its ISR. This was introduced because some network

   335

    drivers' interrupt functions have different arguments.

   336

* State machines now try to re-send datagrams on datagram timeout.

   337

* New option -c of the lsec script, displays slave current consumptions and

   338

  remaining current.

   339

* Added frame counter in master info file.

   340

   341

-------------------------------------------------------------------------------

   342

   343

Changes in version 1.1.1:

   344

   345

* State change FSM: Clearing of sync managers before PREOP.

   346

* Added modules_install make target.

   347

* Device modules for kernel 2.6.17.

   348

* SDO configurations available in Sysfs.

   349

* FMMU configurations cleared when going to INIT.

   350

* Slave-specific logs only at debug level 1 (for large buses).

   351

* Slave flags (error, online) available in Sysfs.

   352

* Acknowledging of spontaneous state changes in master FSMs.

   353

* ecrt_master_deactivate() deprecated.

   354

* Persistent slave lists. Slave structures are only regenerated on topology

   355

  change in IDLE mode.

   356

* SDO reading via Sysfs.

   357

* Added ecrt_domain_register_pdo_range()

   358

* Fetching of SDO dictionary.

   359

* Better timing behaviour when starting up under high CPU load.

   360

* Applied Autotools.

   361

* Improved output of lsec.

   362

* SDO download state machine.

   363

   364

-------------------------------------------------------------------------------

   365

   366

Changes in version 1.1:

   367

   368

* Improved realtime interface.

   369

   370

-------------------------------------------------------------------------------