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

/**

    35

   \file

    36

   Canopen-over-EtherCAT Sdo request functions.

    37

*/

    38

    39

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

    40

    41

#include <linux/module.h>

    42

    43

#include "sdo_request.h"

    44

    45

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

    46

    47

void ec_sdo_request_clear_data(ec_sdo_request_t *);

    48

    49

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

    50

    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;

    74

}

    75

    76

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

    77

    78

/** Sdo request destructor.

    79

 */

    80

void ec_sdo_request_clear(

    81

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

    82

        )

    83

{

    84

    ec_sdo_request_clear_data(req);

    85

}

    86

    87

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

    88

    89

/** Sdo request destructor.

    90

 */

    91

void ec_sdo_request_clear_data(

    92

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

    93

        )

    94

{

    95

    if (req->data) {

    96

        kfree(req->data);

    97

        req->data = NULL;

    98

    }

    99

   100

    req->mem_size = 0;

   101

    req->data_size = 0;

   102

}

   103

   104

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

   105

   106

/** Set the Sdo address.

   107

 */

   108

void ec_sdo_request_address(

   109

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

   110

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

   111

        uint8_t subindex /**< Sdo subindex. */

   112

        )

   113

{

   114

    req->index = index;

   115

    req->subindex = subindex;

   116

}

   117

   118

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

   119

   120

/** Pre-allocates the data memory.

   121

 *

   122

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

   123

 */

   124

int ec_sdo_request_alloc(

   125

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

   126

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

   127

        )

   128

{

   129

    if (size <= req->mem_size)

   130

        return 0;

   131

   132

    ec_sdo_request_clear_data(req);

   133

   134

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

   135

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

   136

        return -1;

   137

    }

   138

   139

    req->mem_size = size;

   140

    req->data_size = 0;

   141

    return 0;

   142

}

   143

   144

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

   145

   146

/** Copies Sdo data from an external source.

   147

 *

   148

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

   149

 */

   150

int ec_sdo_request_copy_data(

   151

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

   152

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

   153

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

   154

        )

   155

{

   156

    if (ec_sdo_request_alloc(req, size))

   157

        return -1;

   158

   159

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

   160

    req->data_size = size;

   161

    return 0;

   162

}

   163

   164

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

   165

 * Realtime interface.

   166

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

   167

   168

void ecrt_sdo_request_timeout(ec_sdo_request_t *req, uint32_t timeout)

   169

{

   170

}

   171

   172

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

   173

   174

uint8_t *ecrt_sdo_request_data(ec_sdo_request_t *req)

   175

{

   176

    return req->data;

   177

}

   178

   179

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

   180

   184

}

   185

   186

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

   187

   188

void ecrt_sdo_request_read(ec_sdo_request_t *req)

   189

{

   190

    req->dir = EC_DIR_INPUT;

   191

    req->state = EC_REQUEST_QUEUED;

   192

}

   193

   194

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

   195

   196

void ecrt_sdo_request_write(ec_sdo_request_t *req)

   197

{

   198

    req->dir = EC_DIR_OUTPUT;

   199

    req->state = EC_REQUEST_QUEUED;

   200

}

   201

   202

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

   203

   204

EXPORT_SYMBOL(ecrt_sdo_request_timeout);

   205

EXPORT_SYMBOL(ecrt_sdo_request_data);

   206

EXPORT_SYMBOL(ecrt_sdo_request_state);

   207

EXPORT_SYMBOL(ecrt_sdo_request_read);

   208

EXPORT_SYMBOL(ecrt_sdo_request_write);

   209

   210

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