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

/** State type translation table.

    58

 */

    59

static const ec_sdo_request_state_t state_translation_table[] = {

    60

    EC_SDO_REQUEST_UNUSED,  // EC_REQUEST_INIT,

    61

    EC_SDO_REQUEST_BUSY,    // EC_REQUEST_QUEUED,

    62

    EC_SDO_REQUEST_BUSY,    // EC_REQUEST_BUSY,

    63

    EC_SDO_REQUEST_SUCCESS, // EC_REQUEST_SUCCESS,

    64

    EC_SDO_REQUEST_ERROR    // EC_REQUEST_FAILURE

    65

};

    66

    67

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

    68

    69

/** Sdo request constructor.

    70

 */

    71

void ec_sdo_request_init(

    72

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

    73

        )

    74

{

    75

    req->data = NULL;

    76

    req->mem_size = 0;

    77

    req->data_size = 0;

    78

    req->dir = EC_DIR_INVALID;

    79

    req->issue_timeout = 0; // no timeout

    80

    req->response_timeout = EC_SDO_REQUEST_RESPONSE_TIMEOUT;

    81

    req->state = EC_REQUEST_INIT;

    82

    req->abort_code = 0x00000000;

    83

}

    84

    85

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

    86

    87

/** Sdo request destructor.

    88

 */

    89

void ec_sdo_request_clear(

    90

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

    91

        )

    92

{

    93

    ec_sdo_request_clear_data(req);

    94

}

    95

    96

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

    97

    98

/** Copy another Sdo request.

    99

 *

   100

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

   101

 */

   102

int ec_sdo_request_copy(

   103

        ec_sdo_request_t *req,

   104

        const ec_sdo_request_t *other

   105

        )

   106

{

   107

    req->index = other->index;

   108

    req->subindex = other->subindex;

   109

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

   110

}

   111

   112

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

   113

   114

/** Sdo request destructor.

   115

 */

   116

void ec_sdo_request_clear_data(

   117

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

   118

        )

   119

{

   120

    if (req->data) {

   121

        kfree(req->data);

   122

        req->data = NULL;

   123

    }

   124

   125

    req->mem_size = 0;

   126

    req->data_size = 0;

   127

}

   128

   129

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

   130

   131

/** Set the Sdo address.

   132

 */

   133

void ec_sdo_request_address(

   134

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

   135

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

   136

        uint8_t subindex /**< Sdo subindex. */

   137

        )

   138

{

   139

    req->index = index;

   140

    req->subindex = subindex;

   141

}

   142

   143

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

   144

   145

/** Pre-allocates the data memory.

   146

 *

   147

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

   148

 */

   149

int ec_sdo_request_alloc(

   150

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

   151

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

   152

        )

   153

{

   154

    if (size <= req->mem_size)

   155

        return 0;

   156

   157

    ec_sdo_request_clear_data(req);

   158

   159

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

   160

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

   161

        return -1;

   162

    }

   163

   164

    req->mem_size = size;

   165

    req->data_size = 0;

   166

    return 0;

   167

}

   168

   169

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

   170

   171

/** Copies Sdo data from an external source.

   172

 *

   173

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

   174

 */

   175

int ec_sdo_request_copy_data(

   176

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

   177

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

   178

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

   179

        )

   180

{

   181

    if (ec_sdo_request_alloc(req, size))

   182

        return -1;

   183

   184

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

   185

    req->data_size = size;

   186

    return 0;

   187

}

   188

   189

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

   190

   191

/** Checks, if the timeout was exceeded.

   192

 *

   193

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

   194

 */

   195

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

   196

{

   197

    return req->issue_timeout

   198

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

   199

}

   200

   201

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

   202

 * Realtime interface.

   203

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

   204

   205

void ecrt_sdo_request_timeout(ec_sdo_request_t *req, uint32_t timeout)

   206

{

   207

    req->issue_timeout = timeout;

   208

}

   209

   210

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

   211

   212

uint8_t *ecrt_sdo_request_data(ec_sdo_request_t *req)

   213

{

   214

    return req->data;

   215

}

   216

   217

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

   218

   219

size_t ecrt_sdo_request_data_size(const ec_sdo_request_t *req)

   220

{

   221

    return req->data_size;

   222

}

   223

   224

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

   225

   226

ec_sdo_request_state_t ecrt_sdo_request_state(const ec_sdo_request_t *req)

   227

{

   228

   return state_translation_table[req->state];

   229

}

   230

   231

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

   232

   233

void ecrt_sdo_request_read(ec_sdo_request_t *req)

   234

{

   235

    req->dir = EC_DIR_INPUT;

   236

    req->state = EC_REQUEST_QUEUED;

   237

    req->abort_code = 0x00000000;

   238

    req->jiffies_start = jiffies;

   239

}

   240

   241

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

   242

   243

void ecrt_sdo_request_write(ec_sdo_request_t *req)

   244

{

   245

    req->dir = EC_DIR_OUTPUT;

   246

    req->state = EC_REQUEST_QUEUED;

   247

    req->abort_code = 0x00000000;

   248

    req->jiffies_start = jiffies;

   249

}

   250

   251

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

   252

   253

/** \cond */

   254

   255

EXPORT_SYMBOL(ecrt_sdo_request_timeout);

   256

EXPORT_SYMBOL(ecrt_sdo_request_data);

   257

EXPORT_SYMBOL(ecrt_sdo_request_data_size);

   258

EXPORT_SYMBOL(ecrt_sdo_request_state);

   259

EXPORT_SYMBOL(ecrt_sdo_request_read);

   260

EXPORT_SYMBOL(ecrt_sdo_request_write);

   261

   262

/** \endcond */

   263

   264

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