1

/******************************************************************************

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2008  Florian Pose, Ingenieurgemeinschaft IgH

     6

 *

     7

 *  This file is part of the IgH EtherCAT Master.

     8

 *

     9

 *  The IgH EtherCAT Master is free software; you can redistribute it and/or

    10

 *  modify it under the terms of the GNU General Public License version 2, as

    11

 *  published by the Free Software Foundation.

    12

 *

    13

 *  The IgH EtherCAT Master is distributed in the hope that it will be useful,

    14

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General

    16

 *  Public License for more details.

    17

 *

    18

 *  You should have received a copy of the GNU General Public License along

    19

 *  with the IgH EtherCAT Master; if not, write to the Free Software

    20

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    21

 *

    22

 *  ---

    23

 *

    24

 *  The license mentioned above concerns the source code only. Using the

    25

 *  EtherCAT technology and brand is only permitted in compliance with the

    26

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    27

 *

    28

 *****************************************************************************/

    29

    30

/** \file

    31

 * Global definitions and macros.

    32

 */

    33

    34

/*****************************************************************************/

    35

    36

#ifndef __EC_MASTER_GLOBALS_H__

    37

#define __EC_MASTER_GLOBALS_H__

    38

    39

#include "../globals.h"

    40

#include "../include/ecrt.h"

    41

    42

#ifdef __KERNEL__

    44

#include <linux/version.h>

    47

#include <linux/rtmutex.h>

    50

#endif // __KERNEL__

    51

    53

#ifdef CONFIG_TRACING

    56

#endif

    57

    58

/******************************************************************************

    59

 * EtherCAT master

    60

 *****************************************************************************/

    61

    62

/** Datagram timeout in microseconds. */

    63

#define EC_IO_TIMEOUT 500

    64

    65

/** FSM injection timeout in microseconds. */

    66

#define EC_FSM_INJECTION_TIMEOUT 10000

    67

    68

/** Time to send a byte in nanoseconds.

    69

 *

    70

 * t_ns = 1 / (100 MBit/s / 8 bit/byte) = 80 ns/byte

    71

 */

    72

#define EC_BYTE_TRANSMISSION_TIME_NS 80

    73

    74

/** Number of state machine retries on datagram timeout. */

    75

#define EC_FSM_RETRIES 3

    76

    77

/** Seconds to wait before fetching SDO dictionary

    78

    after slave entered PREOP state. */

    79

#define EC_WAIT_SDO_DICT 3

    80

    81

/** Minimum size of a buffer used with ec_state_string(). */

    82

#define EC_STATE_STRING_SIZE 32

    83

    84

/** Maximum SII size in words, to avoid infinite reading. */

    85

#define EC_MAX_SII_SIZE 4096

    86

    87

/** Number of statistic rate intervals to maintain. */

    88

#define EC_RATE_COUNT 3

    89

    90

/******************************************************************************

    91

 * EtherCAT protocol

    92

 *****************************************************************************/

    93

    94

/** Size of an EtherCAT frame header. */

    95

#define EC_FRAME_HEADER_SIZE 2

    96

    97

/** Size of an EtherCAT datagram header. */

    98

#define EC_DATAGRAM_HEADER_SIZE 10

    99

   100

/** Size of an EtherCAT datagram footer. */

   101

#define EC_DATAGRAM_FOOTER_SIZE 2

   102

   103

/** Size of the EtherCAT address field. */

   104

#define EC_ADDR_LEN 4

   105

   106

/** Resulting maximum data size of a single datagram in a frame. */

   107

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

   108

                          - EC_DATAGRAM_HEADER_SIZE - EC_DATAGRAM_FOOTER_SIZE)

   109

   110

/** Mailbox header size.  */

   111

#define EC_MBOX_HEADER_SIZE 6

   112

   113

/** Word offset of first SII category. */

   114

#define EC_FIRST_SII_CATEGORY_OFFSET 0x40

   115

   116

/** Size of a sync manager configuration page. */

   117

#define EC_SYNC_PAGE_SIZE 8

   118

   119

/** Maximum number of FMMUs per slave. */

   120

#define EC_MAX_FMMUS 16

   121

   122

/** Size of an FMMU configuration page. */

   123

#define EC_FMMU_PAGE_SIZE 16

   124

   125

/** Number of DC sync signals. */

   126

#define EC_SYNC_SIGNAL_COUNT 2

   127

   128

/** Size of the datagram description string.

   129

 *

   130

 * This is also used as the maximum lenth of EoE device names.

   131

 **/

   132

#define EC_DATAGRAM_NAME_SIZE 20

   133

   134

/** Slave state mask.

   135

 *

   136

 * Apply this mask to a slave state byte to get the slave state without

   137

 * the error flag.

   138

 */

   139

#define EC_SLAVE_STATE_MASK 0x0F

   140

   141

/** State of an EtherCAT slave.

   142

 */

   143

typedef enum {

   144

    EC_SLAVE_STATE_UNKNOWN = 0x00,

   145

    /**< unknown state */

   146

    EC_SLAVE_STATE_INIT = 0x01,

   147

    /**< INIT state (no mailbox communication, no IO) */

   148

    EC_SLAVE_STATE_PREOP = 0x02,

   149

    /**< PREOP state (mailbox communication, no IO) */

   150

    EC_SLAVE_STATE_BOOT = 0x03,

   151

    /**< Bootstrap state (mailbox communication, firmware update) */

   152

    EC_SLAVE_STATE_SAFEOP = 0x04,

   153

    /**< SAFEOP (mailbox communication and input update) */

   154

    EC_SLAVE_STATE_OP = 0x08,

   155

    /**< OP (mailbox communication and input/output update) */

   156

    EC_SLAVE_STATE_ACK_ERR = 0x10

   157

    /**< Acknowledge/Error bit (no actual state) */

   158

} ec_slave_state_t;

   159

   160

/** Supported mailbox protocols.

   161

 */

   162

enum {

   163

    EC_MBOX_AOE = 0x01, /**< ADS over EtherCAT */

   164

    EC_MBOX_EOE = 0x02, /**< Ethernet over EtherCAT */

   165

    EC_MBOX_COE = 0x04, /**< CANopen over EtherCAT */

   166

    EC_MBOX_FOE = 0x08, /**< File-Access over EtherCAT */

   167

    EC_MBOX_SOE = 0x10, /**< Servo-Profile over EtherCAT */

   168

    EC_MBOX_VOE = 0x20  /**< Vendor specific */

   169

};

   170

   171

/** Slave information interface CANopen over EtherCAT details flags.

   172

 */

   173

typedef struct {

   174

    uint8_t enable_sdo : 1; /**< Enable SDO access. */

   175

    uint8_t enable_sdo_info : 1; /**< SDO information service available. */

   176

    uint8_t enable_pdo_assign : 1; /**< PDO mapping configurable. */

   177

    uint8_t enable_pdo_configuration : 1; /**< PDO configuration possible. */

   178

    uint8_t enable_upload_at_startup : 1; /**< ?. */

   179

    uint8_t enable_sdo_complete_access : 1; /**< Complete access possible. */

   180

} ec_sii_coe_details_t;

   181

   182

/** Slave information interface general flags.

   183

 */

   184

typedef struct {

   185

    uint8_t enable_safeop : 1; /**< ?. */

   186

    uint8_t enable_not_lrw : 1; /**< Slave does not support LRW. */

   187

} ec_sii_general_flags_t;

   188

   189

/** EtherCAT slave distributed clocks range.

   190

 */

   191

typedef enum {

   192

    EC_DC_32, /**< 32 bit. */

   193

    EC_DC_64 /*< 64 bit for system time, system time offset and

   194

               port 0 receive time. */

   195

} ec_slave_dc_range_t;

   196

   197

/** EtherCAT slave sync signal configuration.

   198

 */

   199

typedef struct {

   200

    uint32_t cycle_time; /**< Cycle time [ns]. */

   201

    uint32_t shift_time; /**< Shift time [ns]. */

   202

} ec_sync_signal_t;

   203

   204

/** Access states for SDO entries.

   205

 *

   206

 * The access rights are managed per AL state.

   207

 */

   208

enum {

   209

    EC_SDO_ENTRY_ACCESS_PREOP, /**< Access rights in PREOP. */

   210

    EC_SDO_ENTRY_ACCESS_SAFEOP, /**< Access rights in SAFEOP. */

   211

    EC_SDO_ENTRY_ACCESS_OP, /**< Access rights in OP. */

   212

    EC_SDO_ENTRY_ACCESS_COUNT /**< Number of states. */

   213

};

   214

   215

/*****************************************************************************/

   216

   217

/** Convenience macro for printing EtherCAT-specific information to syslog.

   218

 *

   219

 * This will print the message in \a fmt with a prefixed "EtherCAT: ".

   220

 *

   221

 * \param fmt format string (like in printf())

   222

 * \param args arguments (optional)

   223

 */

   224

#define EC_INFO(fmt, args...) \

   225

    printk(KERN_INFO "EtherCAT: " fmt, ##args)

   226

   227

/** Convenience macro for printing EtherCAT-specific errors to syslog.

   228

 *

   229

 * This will print the message in \a fmt with a prefixed "EtherCAT ERROR: ".

   230

 *

   231

 * \param fmt format string (like in printf())

   232

 * \param args arguments (optional)

   233

 */

   234

#define EC_ERR(fmt, args...) \

   235

    printk(KERN_ERR "EtherCAT ERROR: " fmt, ##args)

   236

   237

/** Convenience macro for printing EtherCAT-specific warnings to syslog.

   238

 *

   239

 * This will print the message in \a fmt with a prefixed "EtherCAT WARNING: ".

   240

 *

   241

 * \param fmt format string (like in printf())

   242

 * \param args arguments (optional)

   243

 */

   244

#define EC_WARN(fmt, args...) \

   245

    printk(KERN_WARNING "EtherCAT WARNING: " fmt, ##args)

   246

   247

/** Convenience macro for printing EtherCAT debug messages to syslog.

   248

 *

   249

 * This will print the message in \a fmt with a prefixed "EtherCAT DEBUG: ".

   250

 *

   251

 * \param fmt format string (like in printf())

   252

 * \param args arguments (optional)

   253

 */

   254

#define EC_DBG(fmt, args...) \

   255

    printk(KERN_DEBUG "EtherCAT DEBUG: " fmt, ##args)

   256

   257

/*****************************************************************************/

   258

   259

/** Absolute value.

   260

 */

   261

#define EC_ABS(X) ((X) >= 0 ? (X) : -(X))

   262

   263

/*****************************************************************************/

   264

   265

extern char *ec_master_version_str;

   266

   267

/*****************************************************************************/

   268

   269

unsigned int ec_master_count(void);

   270

void ec_print_data(const uint8_t *, size_t);

   271

void ec_print_data_diff(const uint8_t *, const uint8_t *, size_t);

   272

size_t ec_state_string(uint8_t, char *, uint8_t);

   273

ssize_t ec_mac_print(const uint8_t *, char *);

   274

int ec_mac_is_zero(const uint8_t *);

   275

   276

ec_master_t *ecrt_request_master_err(unsigned int);

   277

   278

/*****************************************************************************/

   279

   280

/** Code/Message pair.

   281

 *

   282

 * Some EtherCAT datagrams support reading a status code to display a certain

   283

 * message. This type allows to map a code to a message string.

   284

 */

   285

typedef struct {

   286

    uint32_t code; /**< Code. */

   287

    const char *message; /**< Message belonging to \a code. */

   288

} ec_code_msg_t;

   289

   290

/*****************************************************************************/

   291

   292

/** Generic request state.

   293

 *

   294

 * \attention If ever changing this, please be sure to adjust the \a

   295

 * state_table in master/sdo_request.c.

   296

 */

   297

typedef enum {

   298

    EC_INT_REQUEST_INIT,

   299

    EC_INT_REQUEST_QUEUED,

   300

    EC_INT_REQUEST_BUSY,

   301

    EC_INT_REQUEST_SUCCESS,

   302

    EC_INT_REQUEST_FAILURE

   303

} ec_internal_request_state_t;

   304

   305

/*****************************************************************************/

   306

   307

extern const ec_request_state_t ec_request_state_translation_table[];

   308

   309

/*****************************************************************************/

   310

   311

/** Origin type.

   312

 */

   313

typedef enum {

   314

    EC_ORIG_INTERNAL, /**< Internal. */

   315

    EC_ORIG_EXTERNAL /**< External. */

   316

} ec_origin_t;

   317

   318

/*****************************************************************************/

   319

   320

typedef struct ec_slave ec_slave_t; /**< \see ec_slave. */

   321

   322

/*****************************************************************************/

   323

   324

#ifdef __KERNEL__

   325

   326

/** Mutual exclusion helpers.

   330

#define ec_mutex_t rt_mutex

   332

static inline void ec_mutex_init(struct ec_mutex_t *mutex)

   333

{

   334

    rt_mutex_init(mutex);

   335

}

   337

static inline void ec_mutex_lock(struct ec_mutex_t *mutex)

   338

{

   339

    rt_mutex_lock(mutex);

   340

}

   342

static inline int ec_mutex_trylock(struct ec_mutex_t *mutex)

   343

{

   344

    return rt_mutex_trylock(mutex);

   345

}

   347

static inline int ec_mutex_lock_interruptible(struct ec_mutex_t *mutex)

   348

{

   352

static inline void ec_mutex_unlock(struct ec_mutex_t *mutex)

   353

{

   354

    rt_mutex_unlock(mutex);

   355

}

   359

#define ec_mutex_t semaphore

   361

static inline void ec_mutex_init(struct ec_mutex_t *sem)

   362

{

   363

    sema_init(sem, 1);

   364

}

   366

static inline void ec_mutex_lock(struct ec_mutex_t *sem)

   367

{

   368

    down(sem);

   369

}

   371

static inline int ec_mutex_trylock(struct ec_mutex_t *sem)

   372

{

   373

    down(sem);

   374

    return 1;

   375

}

   377

static inline int ec_mutex_lock_interruptible(struct ec_mutex_t *sem)

   378

{

   379

    return down_interruptible(sem);

   380

}

   382

static inline void ec_mutex_unlock(struct ec_mutex_t *sem)

   383

{

   384

    up(sem);

   385

}

   386

   389

#endif // __KERNEL__

   390

   393

#endif