1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006  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

    10

 *  and/or modify it under the terms of the GNU General Public License

    11

 *  as published by the Free Software Foundation; either version 2 of the

    12

 *  License, or (at your option) any later version.

    13

 *

    14

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

    15

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

    16

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU General Public License for more details.

    18

 *

    19

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

    20

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

    21

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

    22

 *

    23

 *  The right to use EtherCAT Technology is granted and comes free of

    24

 *  charge under condition of compatibility of product made by

    25

 *  Licensee. People intending to distribute/sell products based on the

    26

 *  code, have to sign an agreement to guarantee that products using

    27

 *  software based on IgH EtherCAT master stay compatible with the actual

    28

 *  EtherCAT specification (which are released themselves as an open

    29

 *  standard) as the (only) precondition to have the right to use EtherCAT

    30

 *  Technology, IP and trade marks.

    31

 *

    32

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

    33

    34

/** \file

    35

 * Canopen-over-EtherCAT Sdo request functions.

    36

 */

    37

    38

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

    39

    40

#include <linux/module.h>

    41

#include <linux/jiffies.h>

    42

    43

#include "sdo_request.h"

    44

    45

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

    46

    47

/** Default timeout in ms to wait for Sdo transfer responses.

    48

 */

    49

#define EC_SDO_REQUEST_RESPONSE_TIMEOUT 3000

    50

    51

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

    52

    53

void ec_sdo_request_clear_data(ec_sdo_request_t *);

    54

    55

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

    56

    57

/** Sdo request constructor.

    58

 */

    59

void ec_sdo_request_init(

    60

        ec_sdo_request_t *req /**< Sdo request. */

    61

        )

    62

{

    63

    req->data = NULL;

    64

    req->mem_size = 0;

    65

    req->data_size = 0;

    66

    req->dir = EC_DIR_INVALID;

    67

    req->issue_timeout = 0; // no timeout

    68

    req->response_timeout = EC_SDO_REQUEST_RESPONSE_TIMEOUT;

    69

    req->state = EC_INT_REQUEST_INIT;

    70

    req->abort_code = 0x00000000;

    71

}

    72

    73

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

    74

    75

/** Sdo request destructor.

    76

 */

    77

void ec_sdo_request_clear(

    78

        ec_sdo_request_t *req /**< Sdo request. */

    79

        )

    80

{

    81

    ec_sdo_request_clear_data(req);

    82

}

    83

    84

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

    85

    86

/** Copy another Sdo request.

    87

 *

    88

 * \attention Only the index subindex and data are copied.

    89

 */

    90

int ec_sdo_request_copy(

    91

        ec_sdo_request_t *req,

    92

        const ec_sdo_request_t *other

    93

        )

    94

{

    95

    req->index = other->index;

    96

    req->subindex = other->subindex;

    97

    return ec_sdo_request_copy_data(req, other->data, other->data_size);

    98

}

    99

   100

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

   101

   102

/** Sdo request destructor.

   103

 */

   104

void ec_sdo_request_clear_data(

   105

        ec_sdo_request_t *req /**< Sdo request. */

   106

        )

   107

{

   108

    if (req->data) {

   109

        kfree(req->data);

   110

        req->data = NULL;

   111

    }

   112

   113

    req->mem_size = 0;

   114

    req->data_size = 0;

   115

}

   116

   117

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

   118

   119

/** Set the Sdo address.

   120

 */

   121

void ec_sdo_request_address(

   122

        ec_sdo_request_t *req, /**< Sdo request. */

   123

        uint16_t index, /**< Sdo index. */

   124

        uint8_t subindex /**< Sdo subindex. */

   125

        )

   126

{

   127

    req->index = index;

   128

    req->subindex = subindex;

   129

}

   130

   131

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

   132

   133

/** Pre-allocates the data memory.

   134

 *

   135

 * If the \a mem_size is already bigger than \a size, nothing is done.

   136

 *

   137

 * \return 0 on success, otherwise -ENOMEM.

   138

 */

   139

int ec_sdo_request_alloc(

   140

        ec_sdo_request_t *req, /**< Sdo request. */

   141

        size_t size /**< Data size to allocate. */

   142

        )

   143

{

   144

    if (size <= req->mem_size)

   145

        return 0;

   146

   147

    ec_sdo_request_clear_data(req);

   148

   149

    if (!(req->data = (uint8_t *) kmalloc(size, GFP_KERNEL))) {

   150

        EC_ERR("Failed to allocate %u bytes of Sdo memory.\n", size);

   151

        return -ENOMEM;

   152

    }

   153

   154

    req->mem_size = size;

   155

    req->data_size = 0;

   156

    return 0;

   157

}

   158

   159

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

   160

   161

/** Copies Sdo data from an external source.

   162

 *

   163

 * If the \a mem_size is to small, new memory is allocated.

   164

 *

   165

 * \retval  0 Success.

   166

 * \retval <0 Error code.

   167

 */

   168

int ec_sdo_request_copy_data(

   169

        ec_sdo_request_t *req, /**< Sdo request. */

   170

        const uint8_t *source, /**< Source data. */

   171

        size_t size /**< Number of bytes in \a source. */

   172

        )

   173

{

   174

    int ret = ec_sdo_request_alloc(req, size);

   175

    if (ret < 0)

   176

        return ret;

   177

   178

    memcpy(req->data, source, size);

   179

    req->data_size = size;

   180

    return 0;

   181

}

   182

   183

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

   184

   185

/** Checks, if the timeout was exceeded.

   186

 *

   187

 * \return non-zero if the timeout was exceeded, else zero.

   188

 */

   189

int ec_sdo_request_timed_out(const ec_sdo_request_t *req /**< Sdo request. */)

   190

{

   191

    return req->issue_timeout

   192

        && jiffies - req->jiffies_start > HZ * req->issue_timeout / 1000;

   193

}

   194

   195

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

   196

 * Realtime interface.

   197

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

   198

   199

void ecrt_sdo_request_timeout(ec_sdo_request_t *req, uint32_t timeout)

   200

{

   201

    req->issue_timeout = timeout;

   202

}

   203

   204

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

   205

   206

uint8_t *ecrt_sdo_request_data(ec_sdo_request_t *req)

   207

{

   208

    return req->data;

   209

}

   210

   211

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

   212

   213

size_t ecrt_sdo_request_data_size(const ec_sdo_request_t *req)

   214

{

   215

    return req->data_size;

   216

}

   217

   218

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

   219

   220

ec_request_state_t ecrt_sdo_request_state(const ec_sdo_request_t *req)

   221

{

   222

   return ec_request_state_translation_table[req->state];

   223

}

   224

   225

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

   226

   227

void ecrt_sdo_request_read(ec_sdo_request_t *req)

   228

{

   229

    req->dir = EC_DIR_INPUT;

   230

    req->state = EC_INT_REQUEST_QUEUED;

   231

    req->abort_code = 0x00000000;

   232

    req->jiffies_start = jiffies;

   233

}

   234

   235

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

   236

   237

void ecrt_sdo_request_write(ec_sdo_request_t *req)

   238

{

   239

    req->dir = EC_DIR_OUTPUT;

   240

    req->state = EC_INT_REQUEST_QUEUED;

   241

    req->abort_code = 0x00000000;

   242

    req->jiffies_start = jiffies;

   243

}

   244

   245

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

   246

   247

/** \cond */

   248

   249

EXPORT_SYMBOL(ecrt_sdo_request_timeout);

   250

EXPORT_SYMBOL(ecrt_sdo_request_data);

   251

EXPORT_SYMBOL(ecrt_sdo_request_data_size);

   252

EXPORT_SYMBOL(ecrt_sdo_request_state);

   253

EXPORT_SYMBOL(ecrt_sdo_request_read);

   254

EXPORT_SYMBOL(ecrt_sdo_request_write);

   255

   256

/** \endcond */

   257

   258

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