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.34 (thanks to Siwei Zhuang), 2.6.37.

    12

    13

Changes in 1.5:

    14

    15

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

    16

  library is licensed under LGPLv2.

    17

* Added distributed clocks support.

    18

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

    19

* Added VoE mailbox protocol support.

    20

* Added SoE mailbox protocol support.

    21

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

    22

  callback functions for sending and receiving datagrams.

    23

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

    24

  datagrams.

    25

* Separated datagram initialization from filling the payload with zeros.

    26

  Introduced new method ec_datagram_zero() for that.

    27

* Added phy_read and phy_write commands to ethercat tool.

    28

* Added e100 driver for Intel PRO/100 NICs.

    29

    - Added e100 driver for 2.6.27.

    30

    - Added e100 driver for 2.6.28, thanks to Kim. H. Madsen.

    31

    - Added e100 driver for 2.6.29, thanks to Andre Puschmann.

    32

    - Added e100 driver for 2.6.31.

    33

    - Added e100 driver for 2.6.32.

    34

    - Added e100 driver for 2.6.33, thanks for J. Kunz.

    35

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

    36

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

    37

  2.6.33 (J. Kunz), 2.6.34 (Malcolm Lewis), 2.6.35 (B. Benner),

    38

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

    39

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

    40

  2.6.33 (J. Kunz), 2.6.37.

    41

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

    42

  (Robbie K), 2.6.33 (J. Kunz).

    43

* Added e1000e driver for 2.6.32, 2.6.33, 2.6.34 (thanks to Siwei Zhuang).

    44

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

    45

  physical device.

    46

* Improved error case return codes of many functions.

    47

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

    48

  O. Zarges.

    49

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

    50

  command-line tool.

    51

* Added ecrt_open_master() and ecrt_master_reserve() separation for

    52

  the userspace library (thanks to Martin Troxler).

    53

* Added bus information interface (methods ecrt_master(),

    54

  ecrt_master_get_slave(), ecrt_master_get_sync_manager(),

    55

  ecrt_master_get_pdo() and ecrt_master_get_pdo_entry()) to get information

    56

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

    57

  Martin Troxler and Stefan Weiser).

    58

* Added ecrt_master_sdo_download() and ecrt_master_sdo_upload()

    59

  methods to let an application transfer SDOs before activating the master

    60

  (thanks to Stefan Weiser).

    61

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

    62

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

    63

  Joerg Mohre).

    64

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

    65

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

    66

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

    67

  Burgstaller.

    68

* Clear slave list on link down.

    69

* Output device link state in 'ethercat master'.

    70

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

    71

  DOT language.

    72

* Changed EC_MAX_SII_SIZE to 4096.

    73

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

    74

  (thanks to E. Burgstaller).

    75

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

    76

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

    77

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

    78

* Switched version control from Subversion to Mercurial.

    79

* Implemented CompleteAccess for SDO downloads.

    80

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

    81

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

    82

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

    83

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

    84

* wildcard for vendor ID and product code.

    85

* Added support for systemd.

    86

    87

Changes in 1.4.0:

    88

    89

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

    90

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

    91

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

    92

  of a domain span several datagrams.

    93

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

    94

  configuration is in progress.

    95

* Fixed typo in logging output.

    96

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

    97

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

    98

  frame.

    99

* Modified licence headers to avoid conflicts with the GPL.

   100

* Restricted licence to GPLv2 only.

   101

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

   102

  (without hyphens).

   103

   104

Changes in 1.4.0-rc3:

   105

   106

* Ported the master thread to the kthread interface.

   107

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

   108

  semaphore was not released.

   109

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

   110

  mailbox protocols.

   111

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

   112

  corresponding SII bit set.

   113

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

   114

* Removed unstable e100, forcedeth, and r8169 drivers.

   115

   116

Changes in version 1.4.0-rc2:

   117

   118

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

   119

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

   120

  after creation.

   121

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

   122

  cases.

   123

* Minor fixes.

   124

* Removed some deprecated files.

   125

   126

Changes in version 1.4.0-rc1:

   127

   128

* Realtime interface changes:

   129

    - Replaced ec_slave_t with ec_slave_config_t, separating the bus

   130

      configuration from the actual slaves. Therefore, renamed

   131

      ecrt_master_get_slave() to ecrt_master_slave_config().

   132

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

   133

      ecrt_master_slave_config().

   134

    - Removed ecrt_master_get_slave_by_pos(), because it is no longer

   135

      necessary due to alias/position addressing.

   136

    - Added ec_slave_config_state_t for the new method

   137

      ecrt_slave_config_state().

   138

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

   139

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

   140

      added the domain methods ecrt_domain_size() and

   141

      ecrt_domain_external_memory().

   142

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

   143

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

   144

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

   145

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

   146

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

   147

      the start address can be retrieved with ecrt_domain_data().

   148

    - Replaced ecrt_slave_pdo_mapping/add/clear() with

   149

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

   150

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

   151

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

   152

      for both, that uses the new data types ec_pdo_info_t and

   153

      ec_pdo_entry_info_t. PDO entries, that are mapped with these functions

   154

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

   155

    - Renamed ec_bus_status_t, ec_master_status_t to ec_bus_state_t and

   156

      ec_master_state_t, respectively. Renamed ecrt_master_get_status() to

   157

      ecrt_master_state(), for consistency reasons.

   158

    - Added ec_domain_state_t and ec_wc_state_t for a new output parameter

   159

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

   160

      information, if the process data was exchanged completely.

   161

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

   162

      renamed ec_pdo_reg_t to ec_pdo_entry_reg_t and ecrt_domain_register_pdo()

   163

      to ecrt_slave_config_reg_pdo_entry().

   164

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

   165

      be reached by specifying an explicit PDO assignment/mapping and

   166

      registering the mapped PDO entries.

   167

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

   168

      scheduled for reading and writing during realtime operation.

   169

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

   170

    - Removed the bus_state and bus_tainted flags from ec_master_state_t.

   171

* Device interface changes:

   172

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

   173

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

   174

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

   175

  is created via udev. The tool is able to

   176

    - Write alias addresses.

   177

    - Show the bus configuration.

   178

    - Output binary domain process data.

   179

    - Set the master's debug level.

   180

    - Show domain information.

   181

    - Show master information.

   182

    - List PDO assignment/mapping.

   183

    - Write an SDO entry.

   184

    - List SDO dictionaries.

   185

    - Read an SDO entry.

   186

    - Output a slave's SII contents.

   187

    - Write slave's SII contents.

   188

    - Show slaves.

   189

    - Request slave states.

   190

    - Generate slave information xmls.

   191

* Removed include/ecdb.h.

   192

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

   193

  because it is only available on Intel architectures.

   194

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

   195

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

   196

* Mapping of PDO entries is now supported.

   197

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

   198

  direct SDO access, independent of the dictionary.

   199

* Network driver news:

   200

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

   201

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

   202

    - Added 8139too driver for kernel 2.6.24.

   203

    - Added e1000 driver for kernel 2.6.22.

   204

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

   205

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

   206

      Hassan.

   207

    - Fixed unnecessary watchdog executions in e1000 drivers (thanks to

   208

      Olav Zarges).

   209

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

   210

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

   211

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

   212

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

   213

  the bus_tainted flag was deprecated and removed.

   214

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

   215

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

   216

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

   217

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

   218

  domains have to be used for inputs and output.

   219

* CoE implementation:

   220

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

   221

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

   222

    - Added some transfer timeouts.

   223

    - Asynchronous handling of Emergency requests.

   224

    - Bug fixes.

   225

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

   226

* Renamed ec_master module parameters main and backup to main_devices and

   227

  backup_devices to avoid warnings of some compilers.

   228

* List end evaluate CoE detail flags from general category.

   229

* Added MODPROBE_FLAGS variable in start script and sysconfig file.

   230

* Implemented missing datagram types.

   231

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

   232

* Allow multiple sync manager categories in SII.

   233

   234

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

   235

   236

Changes in version 1.3.2:

   237

   238

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

   239

* Implemented SII writing workaround for some broken slaves.

   240

* Improved handling for spontaneous AL state changes.

   241

* Master takes mailbox sync manager configurations from EEPROM words

   242

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

   243

* Calculate checksum when writing EEPROM or alias address.

   244

* Fixed source MAC address setting bug.

   245

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

   246

   247

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

   248

   249

Changes in version 1.3.1:

   250

   251

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

   252

  while processing.

   253

* Added some statistics to the datagram structure.

   254

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

   255

  before setting them.

   256

* Added --enable-eoe conditional.

   257

* Minor extensions of the master info file.

   258

* Improved handling of unexpected working counters.

   259

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

   260

* Fixed problems on big-endian systems.

   261

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

   262

   263

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

   264

   265

Changes in version 1.3.0:

   266

   267

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

   268

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

   269

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

   270

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

   271

  dynamically instead.

   272

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

   273

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

   274

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

   275

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

   276

* Changed format of sysconfig file and accordingly adjusted functionality

   277

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

   278

* Realtime interface changes:

   279

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

   280

    run in process context.

   281

  - Parameter changes in PDO registration functions ecrt_domain_register_pdo()

   282

    and ecrt_register_pdo_range(): Replaced slave_address, vendor ID and

   283

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

   284

    a prior call to ecrt_master_get_slave().

   285

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

   286

    and product code.

   287

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

   288

  - Added ecrt_master_get_slave_by_pos() to avoid the string handling of

   289

    ecrt_master_get_slave().

   290

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

   291

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

   292

    ec_slave_pdo_mapping_clear(), ec_slave_pdo_mapping_add() and

   293

    ec_slave_pdo_mapping().

   294

* Device interface changes:

   295

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

   296

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

   297

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

   298

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

   299

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

   300

  writing has finished. Appropriate error codes are returned.

   301

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

   302

* Implemented SDO reading in operation mode via sysfs.

   303

* Removed annoying eeprom_write_enable file. EEPROM writing always enabled.

   304

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

   305

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

   306

  state machine.

   307

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

   308

  as fast as possible (with schedule()).

   309

* Added dummy module for simulation purposes.

   310

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

   311

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

   312

  any more).

   313

* Removed EtherCAT line comments from 8139too drivers.

   314

   315

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

   316

   317

Changes in version 1.2.0:

   318

   319

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

   320

  with kernels 2.6.17 to 2.6.19.

   321

* Realtime interface changes:

   322

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

   323

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

   324

    done in ecrt_domain_process() any more!

   325

  - Removed ecrt_master_deactivate(). Its functionality was moved into

   326

    ecrt_master_release().

   327

  - Removed ecrt_master_prepare(). Its functionality was moved into

   328

    ecrt_master_activate().

   329

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

   330

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

   331

  - The data_ptr parameter of ecrt_domain_register_pdo(),

   332

    ecrt_domain_register_pdo_list() and ecrt_domain_register_pdo_range() may

   333

    not be NULL any more.

   334

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

   335

  - Introduced ECRT_VERSION_MAGIC macro and ecrt_version_magic() function.

   336

* Device interface changes:

   337

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

   338

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

   339

    drivers' interrupt functions have different arguments.

   340

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

   341

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

   342

  remaining current.

   343

* Added frame counter in master info file.

   344

   345

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

   346

   347

Changes in version 1.1.1:

   348

   349

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

   350

* Added modules_install make target.

   351

* Device modules for kernel 2.6.17.

   352

* SDO configurations available in Sysfs.

   353

* FMMU configurations cleared when going to INIT.

   354

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

   355

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

   356

* Acknowledging of spontaneous state changes in master FSMs.

   357

* ecrt_master_deactivate() deprecated.

   358

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

   359

  change in IDLE mode.

   360

* SDO reading via Sysfs.

   361

* Added ecrt_domain_register_pdo_range()

   362

* Fetching of SDO dictionary.

   363

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

   364

* Applied Autotools.

   365

* Improved output of lsec.

   366

* SDO download state machine.

   367

   368

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

   369

   370

Changes in version 1.1:

   371

   372

* Improved realtime interface.

   373

   374

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