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 "command.h"

    46

#include "master.h"

    47

    48

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

    49

    50

/**

    51

   Prepares a mailbox-send command.

    52

   \return pointer to mailbox command data

    53

*/

    54

    55

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

    56

                                    ec_command_t *command, /**< command */

    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 %i does not support mailbox communication!\n",

    65

               slave->ring_position);

    66

        return NULL;

    67

    }

    68

    69

    total_size = size + 6;

    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_command_npwr(command, slave->station_address,

    76

                        slave->sii_rx_mailbox_offset,

    77

                        slave->sii_rx_mailbox_size))

    78

        return NULL;

    79

    80

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

    81

    EC_WRITE_U16(command->data + 2, slave->station_address); // station address

    82

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

    83

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

    84

    85

    return command->data + 6;

    86

}

    87

    88

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

    89

    90

/**

    91

   Prepares a command for checking the mailbox state.

    92

   \return 0 in case of success, else < 0

    93

*/

    94

    95

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

    96

                                ec_command_t *command /**< command */

    97

                                )

    98

{

    99

    // FIXME: second sync manager?

   100

    if (ec_command_nprd(command, slave->station_address, 0x808, 8))

   101

        return -1;

   102

   103

    return 0;

   104

}

   105

   106

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

   107

   108

/**

   109

   Processes a mailbox state checking command.

   110

   \return 0 in case of success, else < 0

   111

*/

   112

   113

int ec_slave_mbox_check(const ec_command_t *command /**< command */)

   114

{

   115

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

   116

}

   117

   118

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

   119

   120

/**

   121

   Prepares a command to fetch mailbox data.

   122

   \return 0 in case of success, else < 0

   123

*/

   124

   125

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

   126

                                ec_command_t *command /**< command */

   127

                                )

   128

{

   129

    if (ec_command_nprd(command, slave->station_address,

   130

                        slave->sii_tx_mailbox_offset,

   131

                        slave->sii_tx_mailbox_size)) return -1;

   132

    return 0;

   133

}

   134

   135

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

   136

   137

/**

   138

   Processes received mailbox data.

   139

   \return pointer to the received data

   140

*/

   141

   142

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

   143

                             ec_command_t *command, /**< command */

   144

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

   145

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

   146

                             )

   147

{

   148

    size_t data_size;

   149

   150

    if ((EC_READ_U8(command->data + 5) & 0x0F) != type) {

   151

        EC_ERR("Unexpected mailbox protocol 0x%02X (exp.: 0x%02X) at"

   152

               " slave %i!\n", EC_READ_U8(command->data + 5), type,

   153

               slave->ring_position);

   154

        return NULL;

   155

    }

   156

   157

    if ((data_size = EC_READ_U16(command->data)) >

   158

        slave->sii_tx_mailbox_size - 6) {

   159

        EC_ERR("Currupt mailbox response detected!\n");

   160

        return NULL;

   161

    }

   162

   163

    *size = data_size;

   164

    return command->data + 6;

   165

}

   166

   167

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

   168

   169

/**

   170

   Sends a mailbox command and waits for its reception.

   171

   \return pointer to the received data

   172

*/

   173

   174

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

   175

                                 ec_command_t *command, /**< command */

   176

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

   177

                                 )

   178

{

   179

    uint8_t type;

   180

   181

    type = EC_READ_U8(command->data + 5);

   182

   183

    if (unlikely(ec_master_simple_io(slave->master, command))) {

   184

        EC_ERR("Mailbox checking failed on slave %i!\n",

   185

               slave->ring_position);

   186

        return NULL;

   187

    }

   188

   189

    return ec_slave_mbox_simple_receive(slave, command, type, size);

   190

}

   191

   192

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

   193

   194

/**

   195

   Waits for the reception of a mailbox command.

   196

   \return pointer to the received data

   197

*/

   198

   199

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

   200

                                      ec_command_t *command, /**< command */

   201

                                      uint8_t type, /**< expected protocol */

   202

                                      size_t *size /**< received data size */

   203

                                      )

   204

{

   205

    cycles_t start, end, timeout;

   206

   207

    start = get_cycles();

   208

    timeout = (cycles_t) 100 * cpu_khz; // 100ms

   209

   210

    while (1)

   211

    {

   212

        if (ec_slave_mbox_prepare_check(slave, command)) return NULL;

   213

        if (unlikely(ec_master_simple_io(slave->master, command))) {

   214

            EC_ERR("Mailbox checking failed on slave %i!\n",

   215

                   slave->ring_position);

   216

            return NULL;

   217

        }

   218

   219

        end = get_cycles();

   220

   221

        if (ec_slave_mbox_check(command))

   222

            break; // proceed with receiving data

   223

   224

        if ((end - start) >= timeout) {

   225

            EC_ERR("Mailbox check - Slave %i timed out.\n",

   226

                   slave->ring_position);

   227

            return NULL;

   228

        }

   229

   230

        udelay(100);

   231

    }

   232

   233

    if (ec_slave_mbox_prepare_fetch(slave, command)) return NULL;

   234

    if (unlikely(ec_master_simple_io(slave->master, command))) {

   235

        EC_ERR("Mailbox receiving failed on slave %i!\n",

   236

               slave->ring_position);

   237

        return NULL;

   238

    }

   239

   240

    if (unlikely(slave->master->debug_level) > 1)

   241

        EC_DBG("Mailbox receive took %ius.\n", ((u32) (end - start) * 1000

   242

                                                / cpu_khz));

   243

   244

    return ec_slave_mbox_fetch(slave, command, type, size);

   245

}

   246

   247

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