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

   Mailbox functionality.

    37

*/

    38

    39

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

    40

    41

#include <linux/slab.h>

    42

#include <linux/delay.h>

    43

    44

#include "mailbox.h"

    45

#include "datagram.h"

    46

#include "master.h"

    47

    48

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

    49

    50

/**

    51

   Prepares a mailbox-send datagram.

    52

   \return pointer to mailbox datagram data

    53

*/

    54

    55

uint8_t *ec_slave_mbox_prepare_send(const ec_slave_t *slave, /**< slave */

    56

                                    ec_datagram_t *datagram, /**< datagram */

    57

                                    uint8_t type, /**< mailbox protocol */

    58

                                    size_t size /**< size of the data */

    59

                                    )

    60

{

    61

    size_t total_size;

    62

    63

    if (unlikely(!slave->sii.mailbox_protocols)) {

    64

        EC_ERR("Slave %u does not support mailbox communication!\n",

    65

               slave->ring_position);

    66

        return NULL;

    67

    }

    68

    69

    total_size = EC_MBOX_HEADER_SIZE + size;

    70

    if (unlikely(total_size > slave->sii.rx_mailbox_size)) {

    71

        EC_ERR("Data size does not fit in mailbox!\n");

    72

        return NULL;

    73

    }

    74

    75

    if (ec_datagram_fpwr(datagram, slave->station_address,

    76

                         slave->sii.rx_mailbox_offset,

    77

                         slave->sii.rx_mailbox_size))

    78

        return NULL;

    79

    80

    EC_WRITE_U16(datagram->data,     size); // mailbox service data length

    81

    EC_WRITE_U16(datagram->data + 2, slave->station_address); // station addr.

    82

    EC_WRITE_U8 (datagram->data + 4, 0x00); // channel & priority

    83

    EC_WRITE_U8 (datagram->data + 5, type); // underlying protocol type

    84

    85

    return datagram->data + EC_MBOX_HEADER_SIZE;

    86

}

    87

    88

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

    89

    90

/**

    91

   Prepares a datagram for checking the mailbox state.

    92

   \todo Determine sync manager used for receive mailbox

    93

   \return 0 in case of success, else < 0

    94

*/

    95

    96

int ec_slave_mbox_prepare_check(const ec_slave_t *slave, /**< slave */

    97

                                ec_datagram_t *datagram /**< datagram */

    98

                                )

    99

{

   100

    if (ec_datagram_fprd(datagram, slave->station_address, 0x808, 8))

   101

        return -1;

   102

   103

    ec_datagram_zero(datagram);

   104

    return 0;

   105

}

   106

   107

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

   108

   109

/**

   110

   Processes a mailbox state checking datagram.

   111

   \return 0 in case of success, else < 0

   112

*/

   113

   114

int ec_slave_mbox_check(const ec_datagram_t *datagram /**< datagram */)

   115

{

   116

    return EC_READ_U8(datagram->data + 5) & 8 ? 1 : 0;

   117

}

   118

   119

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

   120

   121

/**

   122

   Prepares a datagram to fetch mailbox data.

   123

   \return 0 in case of success, else < 0

   124

*/

   125

   126

int ec_slave_mbox_prepare_fetch(const ec_slave_t *slave, /**< slave */

   127

                                ec_datagram_t *datagram /**< datagram */

   128

                                )

   129

{

   130

    if (ec_datagram_fprd(datagram, slave->station_address,

   131

                         slave->sii.tx_mailbox_offset,

   132

                         slave->sii.tx_mailbox_size))

   133

        return -1;

   134

   135

    ec_datagram_zero(datagram);

   136

    return 0;

   137

}

   138

   139

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

   140

   141

/**

   142

   Mailbox error codes.

   143

*/

   144

   145

const ec_code_msg_t mbox_error_messages[] = {

   146

    {0x00000001, "MBXERR_SYNTAX"},

   147

    {0x00000002, "MBXERR_UNSUPPORTEDPROTOCOL"},

   148

    {0x00000003, "MBXERR_INVAILDCHANNEL"},

   149

    {0x00000004, "MBXERR_SERVICENOTSUPPORTED"},

   150

    {0x00000005, "MBXERR_INVALIDHEADER"},

   151

    {0x00000006, "MBXERR_SIZETOOSHORT"},

   152

    {0x00000007, "MBXERR_NOMOREMEMORY"},

   153

    {0x00000008, "MBXERR_INVALIDSIZE"},

   154

    {}

   155

};

   156

   157

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

   158

   159

/**

   160

   Processes received mailbox data.

   161

   \return pointer to the received data

   162

*/

   163

   164

uint8_t *ec_slave_mbox_fetch(const ec_slave_t *slave, /**< slave */

   165

                             ec_datagram_t *datagram, /**< datagram */

   166

                             uint8_t *type, /**< expected mailbox protocol */

   167

                             size_t *size /**< size of the received data */

   168

                             )

   169

{

   170

    size_t data_size;

   171

   172

    data_size = EC_READ_U16(datagram->data);

   173

   174

    if (data_size + EC_MBOX_HEADER_SIZE > slave->sii.tx_mailbox_size) {

   175

        EC_ERR("Corrupt mailbox response received from slave %u!\n",

   176

               slave->ring_position);

   177

        ec_print_data(datagram->data, slave->sii.tx_mailbox_size);

   178

        return NULL;

   179

    }

   180

   181

    *type = EC_READ_U8(datagram->data + 5) & 0x0F;

   182

    *size = data_size;

   183

   184

    if (*type == 0x00) {

   185

        const ec_code_msg_t *mbox_msg;

   186

        uint16_t code = EC_READ_U16(datagram->data + 8);

   187

   188

        EC_ERR("Mailbox error response received from slave %u - ",

   189

                slave->ring_position);

   190

   191

        for (mbox_msg = mbox_error_messages; mbox_msg->code; mbox_msg++) {

   192

            if (mbox_msg->code != code) continue;

   193

            printk("Code 0x%04X: \"%s\".\n",

   194

                   mbox_msg->code, mbox_msg->message);

   195

            break;

   196

        }

   197

   198

        if (!mbox_msg->code)

   199

            printk("Unknown error reply code 0x%04X.\n", code);

   200

   201

        if (slave->master->debug_level)

   202

            ec_print_data(datagram->data + EC_MBOX_HEADER_SIZE, data_size);

   203

   204

        return NULL;

   205

    }

   206

   207

    return datagram->data + EC_MBOX_HEADER_SIZE;

   208

}

   209

   210

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