1

/*

     2

This file is part of CanFestival, a library implementing CanOpen Stack. 

     3

     4

Copyright (C): Edouard TISSERANT and Francis DUPIN

     5

     6

See COPYING file for copyrights details.

     7

     8

This library is free software; you can redistribute it and/or

     9

modify it under the terms of the GNU Lesser General Public

    10

License as published by the Free Software Foundation; either

    11

version 2.1 of the License, or (at your option) any later version.

    12

    13

This library 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

    16

Lesser General Public License for more details.

    17

    18

You should have received a copy of the GNU Lesser General Public

    19

License along with this library; if not, write to the Free Software

    20

Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    21

*/

    22

    23

/** @defgroup pdo Process Data Object (PDO)

    24

 *  PDO is a communication object defined by the DPO communication parameter and PDA mapping parameter objects.

    25

 *  It is an uncomfirmed communication service without protocol overhead.

    26

 *  @ingroup comobj

    27

 */

    28

    29

#ifndef __pdo_h__

    30

#define __pdo_h__

    31

    32

#include <applicfg.h>

    33

#include <def.h>

    34

    35

#include "can.h"

    36

    37

typedef struct struct_s_PDO_status s_PDO_status;

    38

    39

#include "data.h"

    40

    41

/* Handler for RxPDO event timers : empty function that user can overload */

    42

void _RxPDO_EventTimers_Handler(CO_Data *d, UNS32 pdoNum);

    43

    44

/* Status of the TPDO : */

    45

#define PDO_INHIBITED 0x01

    46

#define PDO_RTR_SYNC_READY 0x01

    47

    48

/** The PDO structure */

    49

struct struct_s_PDO_status {

    50

  UNS8 transmit_type_parameter;

    51

  TIMER_HANDLE event_timer;

    52

  TIMER_HANDLE inhibit_timer;

    53

  Message last_message;

    54

};

    55

    56

#define s_PDO_status_Initializer {0, TIMER_NONE, TIMER_NONE, Message_Initializer}

    57

    58

/** definitions of the different types of PDOs' transmission

    59

 * 

    60

 * SYNCHRO(n) means that the PDO will be transmited every n SYNC signal.

    61

 */

    62

#define TRANS_EVERY_N_SYNC(n) (n) /*n = 1 to 240 */

    63

#define TRANS_SYNC_ACYCLIC    0    /* Trans after reception of n SYNC. n = 1 to 240 */

    64

#define TRANS_SYNC_MIN        1    /* Trans after reception of n SYNC. n = 1 to 240 */

    65

#define TRANS_SYNC_MAX        240  /* Trans after reception of n SYNC. n = 1 to 240 */

    66

#define TRANS_RTR_SYNC        252  /* Transmission on request */

    67

#define TRANS_RTR             253  /* Transmission on request */

    68

#define TRANS_EVENT_SPECIFIC  254  /* Transmission on event */

    69

#define TRANS_EVENT_PROFILE   255  /* Transmission on event */

    70

    71

/** 

    72

 * @brief Copy all the data to transmit in process_var

    73

 * Prepare the PDO defined at index to be sent

    74

 * *pwCobId : returns the value of the cobid. (subindex 1)

    75

 * @param *d Pointer on a CAN object data structure

    76

 * @param numPdo The PDO number

    77

 * @param *pdo Pointer on a CAN message structure

    78

 * @return 0 or 0xFF if error.

    79

 */

    80

UNS8 buildPDO(CO_Data* d, UNS8 numPdo, Message *pdo);

    81

    82

/** 

    83

 * @ingroup pdo

    84

 * @brief Transmit a PDO request frame on the network to the slave.

    85

 * @param *d Pointer on a CAN object data structure

    86

 * @param RPDOIndex Index of the receive PDO

    87

 * @return

    88

 *       - CanFestival file descriptor is returned upon success.

    89

 *       - 0xFF is returned if RPDO Index is not found.

    90

    91

 * @return 0xFF if error, other in success.

    92

 */

    93

UNS8 sendPDOrequest( CO_Data* d, UNS16 RPDOIndex );

    94

    95

/**

    96

 * @brief Compute a PDO frame reception

    97

 * bus_id is hardware dependant

    98

 * @param *d Pointer on a CAN object data structure

    99

 * @param *m Pointer on a CAN message structure

   100

 * @return 0xFF if error, else return 0

   101

 */

   102

UNS8 proceedPDO (CO_Data* d, Message *m);

   103

   104

/** 

   105

 * @brief Used by the application to signal changes in process data

   106

 * that could be mapped to some TPDO.

   107

 * This do not necessarily imply PDO emission.

   108

 * Function iterates on all TPDO and look TPDO transmit 

   109

 * type and content change before sending it.    

   110

 * @param *d Pointer on a CAN object data structure

   111

 */

   112

UNS8 sendPDOevent (CO_Data* d);

   113

UNS8 sendOnePDOevent (CO_Data* d, UNS8 pdoNum);

   114

   115

/** 

   116

 * @ingroup pdo

   117

 * @brief Function iterates on all TPDO and look TPDO transmit 

   118

 * type and content change before sending it.

   119

 * @param *d Pointer on a CAN object data structure

   120

 * @param isSyncEvent

   121

 */

   122

UNS8 _sendPDOevent(CO_Data* d, UNS8 isSyncEvent);

   123

   124

/** 

   125

 * @brief Initialize PDO feature 

   126

 * @param *d Pointer on a CAN object data structure

   127

 */

   128

void PDOInit(CO_Data* d);

   129

   130

/** 

   131

 * @brief Stop PDO feature 

   132

 * @param *d Pointer on a CAN object data structure

   133

 */

   134

void PDOStop(CO_Data* d);

   135

   136

/** 

   137

 * @ingroup pdo

   138

 * @brief Set timer for PDO event

   139

 * @param *d Pointer on a CAN object data structure

   140

 * @param pdoNum The PDO number

   141

 */

   142

void PDOEventTimerAlarm(CO_Data* d, UNS32 pdoNum);

   143

   144

/** 

   145

 * @ingroup pdo

   146

 * @brief Inhibit timer for PDO event

   147

 * @param *d Pointer on a CAN object data structure

   148

 * @param pdoNum The PDO number

   149

 */

   150

void PDOInhibitTimerAlarm(CO_Data* d, UNS32 pdoNum);

   151

   152

/* copy bit per bit in little endian */

   153

void CopyBits(UNS8 NbBits, UNS8* SrcByteIndex, UNS8 SrcBitIndex, UNS8 SrcBigEndian, UNS8* DestByteIndex, UNS8 DestBitIndex, UNS8 DestBigEndian);

   154

#endif