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

 * Canopen over EtherCAT SDO request functions.

    32

 */

    33

    34

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

    35

    36

#include <linux/module.h>

    37

#include <linux/jiffies.h>

    38

#include <linux/slab.h>

    39

    40

#include "sdo_request.h"

    41

    42

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

    43

    44

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

    45

 */

    46

#define EC_SDO_REQUEST_RESPONSE_TIMEOUT 1000

    47

    48

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

    49

    50

void ec_sdo_request_clear_data(ec_sdo_request_t *);

    51

    52

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

    53

    54

/** SDO request constructor.

    55

 */

    56

void ec_sdo_request_init(

    57

        ec_sdo_request_t *req /**< SDO request. */

    58

        )

    59

{

    60

    req->complete_access = 0;

    61

    req->data = NULL;

    62

    req->mem_size = 0;

    63

    req->data_size = 0;

    64

    req->dir = EC_DIR_INVALID;

    65

    req->issue_timeout = 0; // no timeout

    66

    req->response_timeout = EC_SDO_REQUEST_RESPONSE_TIMEOUT;

    67

    req->state = EC_INT_REQUEST_INIT;

    68

    req->errno = 0;

    69

    req->abort_code = 0x00000000;

    70

}

    71

    72

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

    73

    74

/** SDO request destructor.

    75

 */

    76

void ec_sdo_request_clear(

    77

        ec_sdo_request_t *req /**< SDO request. */

    78

        )

    79

{

    80

    ec_sdo_request_clear_data(req);

    81

}

    82

    83

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

    84

    85

/** Copy another SDO request.

    86

 *

    87

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

    88

 *

    89

 * \return Zero on success, otherwise a negative error code.

    90

 */

    91

int ec_sdo_request_copy(

    92

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

    93

        const ec_sdo_request_t *other /**< Other SDO request to copy from. */

    94

        )

    95

{

    96

    req->complete_access = other->complete_access;

    97

    req->index = other->index;

    98

    req->subindex = other->subindex;

    99

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

   100

}

   101

   102

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

   103

   104

/** SDO request destructor.

   105

 */

   106

void ec_sdo_request_clear_data(

   107

        ec_sdo_request_t *req /**< SDO request. */

   108

        )

   109

{

   110

    if (req->data) {

   111

        kfree(req->data);

   112

        req->data = NULL;

   113

    }

   114

   115

    req->mem_size = 0;

   116

    req->data_size = 0;

   117

}

   118

   119

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

   120

   121

/** Pre-allocates the data memory.

   122

 *

   123

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

   124

 *

   125

 * \return 0 on success, otherwise -ENOMEM.

   126

 */

   127

int ec_sdo_request_alloc(

   128

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

   129

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

   130

        )

   131

{

   132

    if (size <= req->mem_size)

   133

        return 0;

   134

   135

    ec_sdo_request_clear_data(req);

   136

   137

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

   138

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

   139

        return -ENOMEM;

   140

    }

   141

   142

    req->mem_size = size;

   143

    req->data_size = 0;

   144

    return 0;

   145

}

   146

   147

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

   148

   149

/** Copies SDO data from an external source.

   150

 *

   151

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

   152

 *

   153

 * \retval  0 Success.

   154

 * \retval <0 Error code.

   155

 */

   156

int ec_sdo_request_copy_data(

   157

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

   158

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

   159

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

   160

        )

   161

{

   162

    int ret = ec_sdo_request_alloc(req, size);

   163

    if (ret < 0)

   164

        return ret;

   165

   166

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

   167

    req->data_size = size;

   168

    return 0;

   169

}

   170

   171

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

   172

   173

/** Checks, if the timeout was exceeded.

   174

 *

   175

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

   176

 */

   177

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

   178

{

   179

    return req->issue_timeout

   180

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

   181

}

   182

   183

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

   184

 * Application interface.

   185

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

   186

   187

void ecrt_sdo_request_index(ec_sdo_request_t *req, uint16_t index,

   188

        uint8_t subindex)

   189

{

   190

    req->index = index;

   191

    req->subindex = subindex;

   192

}

   193

   194

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

   195

   196

void ecrt_sdo_request_timeout(ec_sdo_request_t *req, uint32_t timeout)

   197

{

   198

    req->issue_timeout = timeout;

   199

}

   200

   201

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

   202

   203

uint8_t *ecrt_sdo_request_data(ec_sdo_request_t *req)

   204

{

   205

    return req->data;

   206

}

   207

   208

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

   209

   210

size_t ecrt_sdo_request_data_size(const ec_sdo_request_t *req)

   211

{

   212

    return req->data_size;

   213

}

   214

   215

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

   216

   217

ec_request_state_t ecrt_sdo_request_state(const ec_sdo_request_t *req)

   218

{

   219

   return ec_request_state_translation_table[req->state];

   220

}

   221

   222

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

   223

   224

void ecrt_sdo_request_read(ec_sdo_request_t *req)

   225

{

   226

    req->dir = EC_DIR_INPUT;

   227

    req->state = EC_INT_REQUEST_QUEUED;

   228

    req->errno = 0;

   229

    req->abort_code = 0x00000000;

   230

    req->jiffies_start = jiffies;

   231

}

   232

   233

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

   234

   235

void ecrt_sdo_request_write(ec_sdo_request_t *req)

   236

{

   237

    req->dir = EC_DIR_OUTPUT;

   238

    req->state = EC_INT_REQUEST_QUEUED;

   239

    req->errno = 0;

   240

    req->abort_code = 0x00000000;

   241

    req->jiffies_start = jiffies;

   242

}

   243

   244

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

   245

   246

/** \cond */

   247

   248

EXPORT_SYMBOL(ecrt_sdo_request_index);

   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

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