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

 *  Using the EtherCAT technology and brand is permitted in compliance with

    23

 *  the industrial property and similar rights of Beckhoff Automation GmbH.

    24

 *

    25

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

    26

    27

/**

    28

   \file

    29

   Mailbox functionality.

    30

*/

    31

    32

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

    33

    34

#include <linux/slab.h>

    35

#include <linux/delay.h>

    36

    37

#include "mailbox.h"

    38

#include "datagram.h"

    39

#include "master.h"

    40

    41

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

    42

    43

/**

    44

   Prepares a mailbox-send datagram.

    45

   \return Pointer to mailbox datagram data, or ERR_PTR() code.

    46

*/

    47

    48

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

    49

                                    ec_datagram_t *datagram, /**< datagram */

    50

                                    uint8_t type, /**< mailbox protocol */

    51

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

    52

                                    )

    53

{

    54

    size_t total_size;

    55

    int ret;

    56

    57

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

    58

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

    59

               slave->ring_position);

    60

        return ERR_PTR(-EPROTONOSUPPORT);

    61

    }

    62

    63

    total_size = EC_MBOX_HEADER_SIZE + size;

    64

    65

    if (unlikely(total_size > slave->configured_rx_mailbox_size)) {

    66

        EC_ERR("Data size (%u) does not fit in mailbox (%u)!\n",

    67

                total_size, slave->configured_rx_mailbox_size);

    68

        return ERR_PTR(-EOVERFLOW);

    69

    }

    70

    71

    ret = ec_datagram_fpwr(datagram, slave->station_address,

    72

            slave->configured_rx_mailbox_offset,

    73

            slave->configured_rx_mailbox_size);

    74

    if (ret)

    75

        return ERR_PTR(ret);

    76

    77

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

    78

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

    79

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

    80

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

    81

    82

    return datagram->data + EC_MBOX_HEADER_SIZE;

    83

}

    84

    85

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

    86

    87

/**

    88

   Prepares a datagram for checking the mailbox state.

    89

   \todo Determine sync manager used for receive mailbox

    90

   \return 0 in case of success, else < 0

    91

*/

    92

    93

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

    94

                                ec_datagram_t *datagram /**< datagram */

    95

                                )

    96

{

    97

    int ret = ec_datagram_fprd(datagram, slave->station_address, 0x808, 8);

    98

    if (ret)

    99

        return ret;

   100

   101

    ec_datagram_zero(datagram);

   102

    return 0;

   103

}

   104

   105

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

   106

   107

/**

   108

   Processes a mailbox state checking datagram.

   109

   \return 0 in case of success, else < 0

   110

*/

   111

   112

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

   113

{

   114

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

   115

}

   116

   117

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

   118

   119

/**

   120

   Prepares a datagram to fetch mailbox data.

   121

   \return 0 in case of success, else < 0

   122

*/

   123

   124

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

   125

                                ec_datagram_t *datagram /**< datagram */

   126

                                )

   127

{

   128

    int ret = ec_datagram_fprd(datagram, slave->station_address,

   129

            slave->configured_tx_mailbox_offset,

   130

            slave->configured_tx_mailbox_size);

   131

    if (ret)

   132

        return ret;

   133

   134

    ec_datagram_zero(datagram);

   135

    return 0;

   136

}

   137

   138

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

   139

   140

/**

   141

   Mailbox error codes.

   142

*/

   143

   144

const ec_code_msg_t mbox_error_messages[] = {

   145

    {0x00000001, "MBXERR_SYNTAX"},

   146

    {0x00000002, "MBXERR_UNSUPPORTEDPROTOCOL"},

   147

    {0x00000003, "MBXERR_INVAILDCHANNEL"},

   148

    {0x00000004, "MBXERR_SERVICENOTSUPPORTED"},

   149

    {0x00000005, "MBXERR_INVALIDHEADER"},

   150

    {0x00000006, "MBXERR_SIZETOOSHORT"},

   151

    {0x00000007, "MBXERR_NOMOREMEMORY"},

   152

    {0x00000008, "MBXERR_INVALIDSIZE"},

   153

    {}

   154

};

   155

   156

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

   157

   158

/** Processes received mailbox data.

   159

 *

   160

 * \return Pointer to the received data, or ERR_PTR() code.

   161

 */

   162

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

   163

                             ec_datagram_t *datagram, /**< datagram */

   164

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

   165

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

   166

                             )

   167

{

   168

    size_t data_size;

   169

   170

    data_size = EC_READ_U16(datagram->data);

   171

   172

    if (data_size + EC_MBOX_HEADER_SIZE > slave->configured_tx_mailbox_size) {

   173

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

   174

                slave->ring_position);

   175

        ec_print_data(datagram->data, slave->configured_tx_mailbox_size);

   176

        return ERR_PTR(-EPROTO);

   177

    }

   178

   179

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

   180

    *size = data_size;

   181

   182

    if (*type == 0x00) {

   183

        const ec_code_msg_t *mbox_msg;

   184

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

   185

   186

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

   187

                slave->ring_position);

   188

   189

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

   190

            if (mbox_msg->code != code)

   191

                continue;

   192

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

   193

                    mbox_msg->code, mbox_msg->message);

   194

            break;

   195

        }

   196

   197

        if (!mbox_msg->code)

   198

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

   199

   200

        if (slave->master->debug_level)

   201

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

   202

   203

        return ERR_PTR(-EPROTO);

   204

    }

   205

   206

    return datagram->data + EC_MBOX_HEADER_SIZE;

   207

}

   208

   209

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