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; version 2 of the License.

    12

 *

    13

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    14

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    16

 *  GNU General Public License for more details.

    17

 *

    18

 *  You should have received a copy of the GNU General Public License

    19

 *  along 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

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

    23

    24

/**

    25

   \file

    26

   Mailbox functionality.

    27

*/

    28

    29

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

    30

    31

#include <linux/slab.h>

    32

#include <linux/delay.h>

    33

    34

#include "mailbox.h"

    35

#include "command.h"

    36

#include "master.h"

    37

    38

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

    39

    40

/**

    41

   Prepares a mailbox-send command.

    42

   \return pointer to mailbox command data

    43

*/

    44

    45

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

    46

                                    uint8_t type, /**< mailbox protocol */

    47

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

    48

                                    )

    49

{

    50

    ec_command_t *command = &slave->mbox_command;

    51

    size_t total_size;

    52

    53

    if (unlikely(!slave->sii_mailbox_protocols)) {

    54

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

    55

               slave->ring_position);

    56

        return NULL;

    57

    }

    58

    59

    total_size = size + 6;

    60

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

    61

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

    62

        return NULL;

    63

    }

    64

    65

    if (ec_command_npwr(command, slave->station_address,

    66

                        slave->sii_rx_mailbox_offset,

    67

                        slave->sii_rx_mailbox_size))

    68

        return NULL;

    69

    70

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

    71

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

    72

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

    73

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

    74

    75

    return command->data + 6;

    76

}

    77

    78

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

    79

    80

/**

    81

   Prepares a command for checking the mailbox state.

    82

   \return 0 in case of success, else < 0

    83

*/

    84

    85

int ec_slave_mbox_prepare_check(ec_slave_t *slave /**< slave */)

    86

{

    87

    ec_command_t *command = &slave->mbox_command;

    88

    89

    // FIXME: second sync manager?

    90

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

    91

        return -1;

    92

    93

    return 0;

    94

}

    95

    96

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

    97

    98

/**

    99

   Processes a mailbox state checking command.

   100

   \return 0 in case of success, else < 0

   101

*/

   102

   103

int ec_slave_mbox_check(const ec_slave_t *slave /**< slave */)

   104

{

   105

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

   106

}

   107

   108

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

   109

   110

/**

   111

   Prepares a command to fetch mailbox data.

   112

   \return 0 in case of success, else < 0

   113

*/

   114

   115

int ec_slave_mbox_prepare_fetch(ec_slave_t *slave /**< slave */)

   116

{

   117

    ec_command_t *command = &slave->mbox_command;

   118

   119

    if (ec_command_nprd(command, slave->station_address,

   120

                        slave->sii_tx_mailbox_offset,

   121

                        slave->sii_tx_mailbox_size)) return -1;

   122

    return 0;

   123

}

   124

   125

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

   126

   127

/**

   128

   Processes received mailbox data.

   129

   \return pointer to the received data

   130

*/

   131

   132

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

   133

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

   134

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

   135

                             )

   136

{

   137

    ec_command_t *command = &slave->mbox_command;

   138

    size_t data_size;

   139

   140

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

   141

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

   142

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

   143

               slave->ring_position);

   144

        return NULL;

   145

    }

   146

   147

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

   148

        slave->sii_tx_mailbox_size - 6) {

   149

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

   150

        return NULL;

   151

    }

   152

   153

    *size = data_size;

   154

    return command->data + 6;

   155

}

   156

   157

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

   158

   159

/**

   160

   Sends a mailbox command and waits for its reception.

   161

   \return pointer to the received data

   162

*/

   163

   164

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

   165

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

   166

                                 )

   167

{

   168

    uint8_t type;

   169

    ec_command_t *command;

   170

   171

    command = &slave->mbox_command;

   172

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

   173

   174

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

   175

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

   176

               slave->ring_position);

   177

        return NULL;

   178

    }

   179

   180

    return ec_slave_mbox_simple_receive(slave, type, size);

   181

}

   182

   183

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

   184

   185

/**

   186

   Waits for the reception of a mailbox command.

   187

   \return pointer to the received data

   188

*/

   189

   190

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

   191

                                      uint8_t type, /**< expected protocol */

   192

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

   193

                                      )

   194

{

   195

    cycles_t start, end, timeout;

   196

    ec_command_t *command;

   197

   198

    command = &slave->mbox_command;

   199

    start = get_cycles();

   200

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

   201

   202

    while (1)

   203

    {

   204

        if (ec_slave_mbox_prepare_check(slave)) return NULL;

   205

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

   206

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

   207

                   slave->ring_position);

   208

            return NULL;

   209

        }

   210

   211

        end = get_cycles();

   212

   213

        if (ec_slave_mbox_check(slave))

   214

            break; // proceed with receiving data

   215

   216

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

   217

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

   218

                   slave->ring_position);

   219

            return NULL;

   220

        }

   221

   222

        udelay(100);

   223

    }

   224

   225

    if (ec_slave_mbox_prepare_fetch(slave)) return NULL;

   226

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

   227

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

   228

               slave->ring_position);

   229

        return NULL;

   230

    }

   231

   232

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

   233

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

   234

                                                / cpu_khz));

   235

   236

    return ec_slave_mbox_fetch(slave, type, size);

   237

}

   238

   239

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