master/pdo.h
branchstable-1.3
changeset 1744 7bc131b92039
child 792 3778920f61e4
equal deleted inserted replaced
1743:1a7067207637 1744:7bc131b92039
       
     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    EtherCAT Process data object structure.
       
    37 */
       
    38 
       
    39 /*****************************************************************************/
       
    40 
       
    41 #ifndef _EC_PDO_H_
       
    42 #define _EC_PDO_H_
       
    43 
       
    44 #include <linux/list.h>
       
    45 
       
    46 #include "globals.h"
       
    47 
       
    48 /*****************************************************************************/
       
    49 
       
    50 /**
       
    51  * PDO type.
       
    52  */
       
    53 
       
    54 typedef enum
       
    55 {
       
    56     EC_RX_PDO, /**< Reveive PDO */
       
    57     EC_TX_PDO /**< Transmit PDO */
       
    58 }
       
    59 ec_pdo_type_t;
       
    60 
       
    61 /*****************************************************************************/
       
    62 
       
    63 /**
       
    64  * PDO description.
       
    65  */
       
    66 
       
    67 typedef struct
       
    68 {
       
    69     struct list_head list; /**< list item */
       
    70     ec_pdo_type_t type; /**< PDO type */
       
    71     uint16_t index; /**< PDO index */
       
    72     int8_t sync_index; /**< assigned sync manager */
       
    73     char *name; /**< PDO name */
       
    74     struct list_head entries; /**< entry list */
       
    75 }
       
    76 ec_pdo_t;
       
    77 
       
    78 /*****************************************************************************/
       
    79 
       
    80 /**
       
    81  * PDO entry description.
       
    82  */
       
    83 
       
    84 typedef struct
       
    85 {
       
    86     struct list_head list; /**< list item */
       
    87     uint16_t index; /**< PDO entry index */
       
    88     uint8_t subindex; /**< PDO entry subindex */
       
    89     char *name; /**< entry name */
       
    90     uint8_t bit_length; /**< entry length in bit */
       
    91 }
       
    92 ec_pdo_entry_t;
       
    93 
       
    94 /*****************************************************************************/
       
    95 
       
    96 void ec_pdo_init(ec_pdo_t *);
       
    97 void ec_pdo_clear(ec_pdo_t *);
       
    98 int ec_pdo_copy(ec_pdo_t *, const ec_pdo_t *);
       
    99 
       
   100 /*****************************************************************************/
       
   101 
       
   102 #endif