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

    39

#include "sdo_request.h"

    40

    41

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

    42

    43

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

    44

 */

    45

#define EC_SDO_REQUEST_RESPONSE_TIMEOUT 3000

    46

    47

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

    48

    49

void ec_sdo_request_clear_data(ec_sdo_request_t *);

    50

    51

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

    52

    53

/** SDO request constructor.

    54

 */

    55

void ec_sdo_request_init(

    56

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

    57

        )

    58

{

    59

    req->data = NULL;

    60

    req->mem_size = 0;

    61

    req->data_size = 0;

    62

    req->dir = EC_DIR_INVALID;

    63

    req->issue_timeout = 0; // no timeout

    64

    req->response_timeout = EC_SDO_REQUEST_RESPONSE_TIMEOUT;

    65

    req->state = EC_INT_REQUEST_INIT;

    66

    req->abort_code = 0x00000000;

    67

}

    68

    69

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

    70

    71

/** SDO request destructor.

    72

 */

    73

void ec_sdo_request_clear(

    74

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

    75

        )

    76

{

    77

    ec_sdo_request_clear_data(req);

    78

}

    79

    80

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

    81

    82

/** Copy another SDO request.

    83

 *

    84

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

    85

 */

    86

int ec_sdo_request_copy(

    87

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

    88

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

    89

        )

    90

{

    91

    req->index = other->index;

    92

    req->subindex = other->subindex;

    93

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

    94

}

    95

    96

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

    97

    98

/** SDO request destructor.

    99

 */

   100

void ec_sdo_request_clear_data(

   101

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

   102

        )

   103

{

   104

    if (req->data) {

   105

        kfree(req->data);

   106

        req->data = NULL;

   107

    }

   108

   109

    req->mem_size = 0;

   110

    req->data_size = 0;

   111

}

   112

   113

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

   114

   115

/** Set the SDO address.

   116

 */

   117

void ec_sdo_request_address(

   118

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

   119

        uint16_t index, /**< SDO index. */

   120

        uint8_t subindex /**< SDO subindex. */

   121

        )

   122

{

   123

    req->index = index;

   124

    req->subindex = subindex;

   125

}

   126

   127

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

   128

   129

/** Pre-allocates the data memory.

   130

 *

   131

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

   132

 *

   133

 * \return 0 on success, otherwise -ENOMEM.

   134

 */

   135

int ec_sdo_request_alloc(

   136

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

   137

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

   138

        )

   139

{

   140

    if (size <= req->mem_size)

   141

        return 0;

   142

   143

    ec_sdo_request_clear_data(req);

   144

   145

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

   146

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

   147

        return -ENOMEM;

   148

    }

   149

   150

    req->mem_size = size;

   151

    req->data_size = 0;

   152

    return 0;

   153

}

   154

   155

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

   156

   157

/** Copies SDO data from an external source.

   158

 *

   159

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

   160

 *

   161

 * \retval  0 Success.

   162

 * \retval <0 Error code.

   163

 */

   164

int ec_sdo_request_copy_data(

   165

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

   166

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

   167

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

   168

        )

   169

{

   170

    int ret = ec_sdo_request_alloc(req, size);

   171

    if (ret < 0)

   172

        return ret;

   173

   174

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

   175

    req->data_size = size;

   176

    return 0;

   177

}

   178

   179

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

   180

   181

/** Checks, if the timeout was exceeded.

   182

 *

   183

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

   184

 */

   185

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

   186

{

   187

    return req->issue_timeout

   188

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

   189

}

   190

   191

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

   192

 * Realtime interface.

   193

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

   194

   195

void ecrt_sdo_request_timeout(ec_sdo_request_t *req, uint32_t timeout)

   196

{

   197

    req->issue_timeout = timeout;

   198

}

   199

   200

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

   201

   202

uint8_t *ecrt_sdo_request_data(ec_sdo_request_t *req)

   203

{

   204

    return req->data;

   205

}

   206

   207

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

   208

   209

size_t ecrt_sdo_request_data_size(const ec_sdo_request_t *req)

   210

{

   211

    return req->data_size;

   212

}

   213

   214

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

   215

   216

ec_request_state_t ecrt_sdo_request_state(const ec_sdo_request_t *req)

   217

{

   218

   return ec_request_state_translation_table[req->state];

   219

}

   220

   221

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

   222

   223

void ecrt_sdo_request_read(ec_sdo_request_t *req)

   224

{

   225

    req->dir = EC_DIR_INPUT;

   226

    req->state = EC_INT_REQUEST_QUEUED;

   227

    req->abort_code = 0x00000000;

   228

    req->jiffies_start = jiffies;

   229

}

   230

   231

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

   232

   233

void ecrt_sdo_request_write(ec_sdo_request_t *req)

   234

{

   235

    req->dir = EC_DIR_OUTPUT;

   236

    req->state = EC_INT_REQUEST_QUEUED;

   237

    req->abort_code = 0x00000000;

   238

    req->jiffies_start = jiffies;

   239

}

   240

   241

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

   242

   243

/** \cond */

   244

   245

EXPORT_SYMBOL(ecrt_sdo_request_timeout);

   246

EXPORT_SYMBOL(ecrt_sdo_request_data);

   247

EXPORT_SYMBOL(ecrt_sdo_request_data_size);

   248

EXPORT_SYMBOL(ecrt_sdo_request_state);

   249

EXPORT_SYMBOL(ecrt_sdo_request_read);

   250

EXPORT_SYMBOL(ecrt_sdo_request_write);

   251

   252

/** \endcond */

   253

   254

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