include/def.h

   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
  24 #ifndef __def_h__
  25 #define __def_h__
  26
  27 #include "config.h"
  28
  29 /** definitions used for object dictionary access. ie SDO Abort codes . (See DS 301 v.4.02 p.48)
  30  */
  31 #define OD_SUCCESSFUL                0x00000000
  32 #define OD_READ_NOT_ALLOWED          0x06010001
  33 #define OD_WRITE_NOT_ALLOWED         0x06010002
  34 #define OD_NO_SUCH_OBJECT            0x06020000
  35 #define OD_NOT_MAPPABLE              0x06040041
  36 #define OD_LENGTH_DATA_INVALID       0x06070010
  37 #define OD_NO_SUCH_SUBINDEX          0x06090011
  38 #define OD_VALUE_RANGE_EXCEEDED      0x06090030 /* Value range test result */
  39 #define OD_VALUE_TOO_LOW             0x06090031 /* Value range test result */
  40 #define OD_VALUE_TOO_HIGH            0x06090032 /* Value range test result */
  41 /* Others SDO abort codes
  42  */
  43 #define SDOABT_TOGGLE_NOT_ALTERNED   0x05030000
  44 #define SDOABT_TIMED_OUT             0x05040000
  45 #define SDOABT_OUT_OF_MEMORY         0x05040005 /* Size data exceed SDO_MAX_LENGTH_TRANSFERT */
  46 #define SDOABT_GENERAL_ERROR         0x08000000 /* Error size of SDO message */
  47 #define SDOABT_LOCAL_CTRL_ERROR      0x08000021
  48
  49 /******************** CONSTANTS ****************/
  50
  51 /** Constantes which permit to define if a PDO frame
  52    is a request one or a data one
  53 */
  54 /* Should not be modified */
  55 #define REQUEST 1
  56 #define NOT_A_REQUEST 0
  57
  58 /* Misc constants */
  59 /* -------------- */
  60 /* Should not be modified */
  61 #define Rx 0
  62 #define Tx 1
  63 #ifndef TRUE
  64 #define TRUE  1
  65 #endif
  66 #ifndef FALSE
  67 #define FALSE 0
  68 #endif
  69
  70 /** Status of the SDO transmission
  71  */
  72 #define SDO_RESET                0x0      /* Transmission not started. Init state. */
  73 #define SDO_FINISHED             0x1      /* data are available */
  74 #define SDO_ABORTED_RCV          0x80     /* Received an abort message. Data not available */
  75 #define SDO_ABORTED_INTERNAL     0x85     /* Aborted but not because of an abort message. */
  76 #define SDO_DOWNLOAD_IN_PROGRESS 0x2
  77 #define SDO_UPLOAD_IN_PROGRESS   0x3
  78
  79 /* Status of the node during the SDO transfert : */
  80 #define SDO_SERVER  0x1
  81 #define SDO_CLIENT  0x2
  82 #define SDO_UNKNOWN 0x3
  83
  84 /* SDOrx ccs: client command specifier */
  85 #define DOWNLOAD_SEGMENT_REQUEST     0
  86 #define INITIATE_DOWNLOAD_REQUEST    1
  87 #define INITIATE_UPLOAD_REQUEST      2
  88 #define UPLOAD_SEGMENT_REQUEST       3
  89 #define ABORT_TRANSFER_REQUEST       4
  90
  91 /* SDOtx scs: server command specifier */
  92 #define UPLOAD_SEGMENT_RESPONSE      0
  93 #define DOWNLOAD_SEGMENT_RESPONSE    1
  94 #define INITIATE_DOWNLOAD_RESPONSE   3
  95 #define INITIATE_UPLOAD_RESPONSE     2
  96 #define ABORT_TRANSFER_REQUEST       4
  97
  98
  99 /*  Function Codes
 100    ---------------
 101   defined in the canopen DS301
 102 */
 103 #define NMT        0x0
 104 #define SYNC       0x1
 105 #define TIME_STAMP 0x2
 106 #define PDO1tx     0x3
 107 #define PDO1rx     0x4
 108 #define PDO2tx     0x5
 109 #define PDO2rx     0x6
 110 #define PDO3tx     0x7
 111 #define PDO3rx     0x8
 112 #define PDO4tx     0x9
 113 #define PDO4rx     0xA
 114 #define SDOtx      0xB
 115 #define SDOrx      0xC
 116 #define NODE_GUARD 0xE
 117 #define LSS        0xF
 118
 119 /* NMT Command Specifier, sent by master to change a slave state */
 120 /* ------------------------------------------------------------- */
 121 /* Should not be modified */
 122 #define NMT_Start_Node              0x01
 123 #define NMT_Stop_Node               0x02
 124 #define NMT_Enter_PreOperational    0x80
 125 #define NMT_Reset_Node              0x81
 126 #define NMT_Reset_Comunication      0x82
 127
 128 /** Status of the LSS transmission
 129  */
 130 #define LSS_RESET                0x0      /* Transmission not started. Init state. */
 131 #define LSS_FINISHED             0x1      /* data are available */
 132 #define LSS_ABORTED_INTERNAL     0x2     /* Aborted but not because of an abort message. */
 133 #define LSS_TRANS_IN_PROGRESS    0x3
 134
 135 /* constantes used in the different state machines */
 136 /* ----------------------------------------------- */
 137 /* Must not be modified */
 138 #define state1  0x01
 139 #define state2  0x02
 140 #define state3  0x03
 141 #define state4  0x04
 142 #define state5  0x05
 143 #define state6  0x06
 144 #define state7  0x07
 145 #define state8  0x08
 146 #define state9  0x09
 147 #define state10 0x0A
 148 #define state11 0x0B
 149
 150 #endif /* __def_h__ */
 151