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

void ec_sdo_request_clear_data(ec_sdo_request_t *);

    48

    49

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

    50

    51

/** State type translation table.

    52

 */

    53

static const ec_sdo_request_state_t state_translation_table[] = {

    54

    EC_SDO_REQUEST_UNUSED,  // EC_REQUEST_INIT,

    55

    EC_SDO_REQUEST_BUSY,    // EC_REQUEST_QUEUED,

    56

    EC_SDO_REQUEST_BUSY,    // EC_REQUEST_BUSY,

    57

    EC_SDO_REQUEST_SUCCESS, // EC_REQUEST_SUCCESS,

    58

    EC_SDO_REQUEST_ERROR    // EC_REQUEST_FAILURE

    59

};

    60

    61

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

    62

    63

/** Sdo request constructor.

    64

 */

    65

void ec_sdo_request_init(

    66

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

    67

        )

    68

{

    69

    req->data = NULL;

    70

    req->mem_size = 0;

    71

    req->data_size = 0;

    72

    req->dir = EC_DIR_OUTPUT;

    73

    req->timeout = 0; // no timeout

    74

    req->state = EC_REQUEST_INIT;

    75

}

    76

    77

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

    78

    79

/** Sdo request destructor.

    80

 */

    81

void ec_sdo_request_clear(

    82

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

    83

        )

    84

{

    85

    ec_sdo_request_clear_data(req);

    86

}

    87

    88

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

    89

    90

/** Sdo request destructor.

    91

 */

    92

void ec_sdo_request_clear_data(

    93

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

    94

        )

    95

{

    96

    if (req->data) {

    97

        kfree(req->data);

    98

        req->data = NULL;

    99

    }

   100

   101

    req->mem_size = 0;

   102

    req->data_size = 0;

   103

}

   104

   105

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

   106

   107

/** Set the Sdo address.

   108

 */

   109

void ec_sdo_request_address(

   110

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

   111

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

   112

        uint8_t subindex /**< Sdo subindex. */

   113

        )

   114

{

   115

    req->index = index;

   116

    req->subindex = subindex;

   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

int ec_sdo_request_alloc(

   126

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

   127

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

   128

        )

   129

{

   130

    if (size <= req->mem_size)

   131

        return 0;

   132

   133

    ec_sdo_request_clear_data(req);

   134

   135

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

   136

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

   137

        return -1;

   138

    }

   139

   140

    req->mem_size = size;

   141

    req->data_size = 0;

   142

    return 0;

   143

}

   144

   145

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

   146

   147

/** Copies Sdo data from an external source.

   148

 *

   149

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

   150

 */

   151

int ec_sdo_request_copy_data(

   152

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

   153

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

   154

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

   155

        )

   156

{

   157

    if (ec_sdo_request_alloc(req, size))

   158

        return -1;

   159

   160

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

   161

    req->data_size = size;

   162

    return 0;

   163

}

   164

   165

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

   166

   167

/** Checks, if the timeout was exceeded.

   168

 *

   169

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

   170

 */

   171

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

   172

{

   173

    return req->timeout

   174

        && jiffies - req->start_jiffies > HZ * req->timeout / 1000;

   175

}

   176

   177

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

   178

 * Realtime interface.

   179

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

   180

   181

void ecrt_sdo_request_timeout(ec_sdo_request_t *req, uint32_t timeout)

   182

{

   183

    req->timeout = timeout;

   184

}

   185

   186

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

   187

   188

uint8_t *ecrt_sdo_request_data(ec_sdo_request_t *req)

   189

{

   190

    return req->data;

   191

}

   192

   193

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

   194

   195

size_t ecrt_sdo_request_data_size(const ec_sdo_request_t *req)

   196

{

   197

    return req->data_size;

   198

}

   199

   200

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

   201

   202

ec_sdo_request_state_t ecrt_sdo_request_state(const ec_sdo_request_t *req)

   203

{

   204

   return state_translation_table[req->state];

   205

}

   206

   207

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

   208

   209

void ecrt_sdo_request_read(ec_sdo_request_t *req)

   210

{

   211

    req->dir = EC_DIR_INPUT;

   212

    req->state = EC_REQUEST_QUEUED;

   213

    req->start_jiffies = jiffies;

   214

}

   215

   216

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

   217

   218

void ecrt_sdo_request_write(ec_sdo_request_t *req)

   219

{

   220

    req->dir = EC_DIR_OUTPUT;

   221

    req->state = EC_REQUEST_QUEUED;

   222

    req->start_jiffies = jiffies;

   223

}

   224

   225

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

   226

   227

/** \cond */

   228

   229

EXPORT_SYMBOL(ecrt_sdo_request_timeout);

   230

EXPORT_SYMBOL(ecrt_sdo_request_data);

   231

EXPORT_SYMBOL(ecrt_sdo_request_data_size);

   232

EXPORT_SYMBOL(ecrt_sdo_request_state);

   233

EXPORT_SYMBOL(ecrt_sdo_request_read);

   234

EXPORT_SYMBOL(ecrt_sdo_request_write);

   235

   236

/** \endcond */

   237

   238

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