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

    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

    56

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

    57

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

    58

               slave->ring_position);

    59

        return NULL;

    60

    }

    61

    62

    total_size = size + 6;

    63

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

    64

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

    65

        return NULL;

    66

    }

    67

    68

    if (ec_datagram_fpwr(datagram, slave->station_address,

    69

                         slave->sii.rx_mailbox_offset,

    70

                         slave->sii.rx_mailbox_size))

    71

        return NULL;

    72

    73

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

    74

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

    75

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

    76

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

    77

    78

    return datagram->data + 6;

    79

}

    80

    81

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

    82

    83

/**

    84

   Prepares a datagram for checking the mailbox state.

    85

   \todo Determine sync manager used for receive mailbox

    86

   \return 0 in case of success, else < 0

    87

*/

    88

    89

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

    90

                                ec_datagram_t *datagram /**< datagram */

    91

                                )

    92

{

    93

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

    94

        return -1;

    95

    96

    return 0;

    97

}

    98

    99

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

   100

   101

/**

   102

   Processes a mailbox state checking datagram.

   103

   \return 0 in case of success, else < 0

   104

*/

   105

   106

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

   107

{

   108

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

   109

}

   110

   111

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

   112

   113

/**

   114

   Prepares a datagram to fetch mailbox data.

   115

   \return 0 in case of success, else < 0

   116

*/

   117

   118

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

   119

                                ec_datagram_t *datagram /**< datagram */

   120

                                )

   121

{

   122

    if (ec_datagram_fprd(datagram, slave->station_address,

   123

                         slave->sii.tx_mailbox_offset,

   124

                         slave->sii.tx_mailbox_size)) return -1;

   125

    return 0;

   126

}

   127

   128

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

   129

   130

/**

   131

   Mailbox error codes.

   132

*/

   133

   134

const ec_code_msg_t mbox_error_messages[] = {

   135

    {0x00000001, "MBXERR_SYNTAX"},

   136

    {0x00000002, "MBXERR_UNSUPPORTEDPROTOCOL"},

   137

    {0x00000003, "MBXERR_INVAILDCHANNEL"},

   138

    {0x00000004, "MBXERR_SERVICENOTSUPPORTED"},

   139

    {0x00000005, "MBXERR_INVALIDHEADER"},

   140

    {0x00000006, "MBXERR_SIZETOOSHORT"},

   141

    {0x00000007, "MBXERR_NOMOREMEMORY"},

   142

    {0x00000008, "MBXERR_INVALIDSIZE"},

   143

    {}

   144

};

   145

   146

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

   147

   148

/**

   149

   Processes received mailbox data.

   150

   \return pointer to the received data

   151

*/

   152

   153

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

   154

                             ec_datagram_t *datagram, /**< datagram */

   155

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

   156

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

   157

                             )

   158

{

   159

    size_t data_size;

   160

   161

    data_size = EC_READ_U16(datagram->data);

   162

   163

    if (data_size > slave->sii.tx_mailbox_size - 6) {

   164

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

   165

               slave->ring_position);

   166

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

   167

        return NULL;

   168

    }

   169

   170

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

   171

    *size = data_size;

   172

   173

    if (*type == 0x00) {

   174

        const ec_code_msg_t *mbox_msg;

   175

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

   176

   177

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

   178

               slave->ring_position);

   179

   180

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

   181

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

   182

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

   183

                   mbox_msg->code, mbox_msg->message);

   184

            break;

   185

        }

   186

   187

        if (!mbox_msg->code)

   188

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

   189

   190

        if (slave->master->debug_level)

   191

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

   192

   193

        return NULL;

   194

    }

   195

   196

    return datagram->data + 6;

   197

}

   198

   199

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