eeprom.h

Go to the documentation of this file.

 
/*
 * This file is part of libethercat.
 *
 * libethercat is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 * 
 * libethercat is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public 
 * License along with libethercat (LICENSE.LGPL-V3); if not, write 
 * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth 
 * Floor, Boston, MA  02110-1301, USA.
 * 
 * Please note that the use of the EtherCAT technology, the EtherCAT 
 * brand name and the EtherCAT logo is only permitted if the property 
 * rights of Beckhoff Automation GmbH are observed. For further 
 * information please contact Beckhoff Automation GmbH & Co. KG, 
 * Hülshorstweg 20, D-33415 Verl, Germany (www.beckhoff.com) or the 
 * EtherCAT Technology Group, Ostendstraße 196, D-90482 Nuremberg, 
 * Germany (ETG, www.ethercat.org).
 *
 */
 
#ifndef LIBETHERCAT_EEPROM_H
#define LIBETHERCAT_EEPROM_H
 
#include <libosal/queue.h>
#include <libosal/types.h>
 
#include "libethercat/common.h"
 
//------------------ Category General ---------------
 
typedef struct PACKED ec_eeprom_cat_general {
    osal_uint8_t group_idx;          
    osal_uint8_t img_idx;            
    osal_uint8_t order_idx;          
    osal_uint8_t name_idx;           
    osal_uint8_t physical_layer;     
    osal_uint8_t can_open;           
    osal_uint8_t file_access;        
    osal_uint8_t ethernet;           
    osal_uint8_t soe_channels;       
    osal_uint8_t ds402_channels;     
    osal_uint8_t sysman_class;       
    osal_uint8_t flags;              
    osal_uint16_t current_on_ebus;   
} ec_eeprom_cat_general_t;
    
//------------------ Category PDO -------------------
 
typedef struct PACKED ec_eeprom_cat_pdo_entry {
    osal_uint16_t entry_index;       
    osal_uint8_t sub_index;          
    osal_uint8_t entry_name_idx;     
    osal_uint8_t data_type;          
    osal_uint8_t bit_len;            
    osal_uint16_t flags;             
} ec_eeprom_cat_pdo_entry_t;
 
typedef struct ec_eeprom_cat_pdo {
    struct PACKED {
        osal_uint16_t pdo_index;         
        osal_uint8_t n_entry;            
        osal_uint8_t sm_nr;              
        osal_uint8_t dc_sync;            
        osal_uint8_t name_idx;           
        osal_uint16_t flags;             
 
#define EC_EEPROM_CAT_PDO_LEN   (osal_size_t)8u
    };
 
    ec_eeprom_cat_pdo_entry_t entries[LEC_MAX_EEPROM_CAT_PDO_ENTRIES];
    
    TAILQ_ENTRY(ec_eeprom_cat_pdo) qh;
} ec_eeprom_cat_pdo_t;
 
TAILQ_HEAD(ec_eeprom_cat_pdo_queue, ec_eeprom_cat_pdo);
 
//------------------ Category SM --------------------
 
typedef struct PACKED ec_eeprom_cat_sm {
    osal_uint16_t adr;               
    osal_uint16_t len;               
    osal_uint8_t  ctrl_reg;          
    osal_uint8_t  status_reg;        
    osal_uint8_t  activate;          
    osal_uint8_t  pdi_ctrl;          
} PACKED ec_eeprom_cat_sm_t;
 
//------------------ Category DC --------------------
 
typedef struct PACKED ec_eeprom_cat_dc {
    osal_uint32_t cycle_time_0;         
    osal_uint32_t shift_time_0;         
    osal_uint32_t shift_time_1;         
    osal_int16_t  sync_1_cycle_factor;  
    osal_uint16_t assign_active;        
    osal_int16_t  sync_0_cycle_factor;  
    osal_uint8_t  name_idx;             
    osal_uint8_t  desc_idx;             
    osal_uint8_t  reserved[4];          
#define EC_EEPROM_CAT_DC_LEN    (osal_size_t)25u
} PACKED ec_eeprom_cat_dc_t;
 
//------------------ Category FMMU ------------------
 
typedef struct PACKED ec_eeprom_cat_fmmu {
    osal_uint8_t type;                      
} PACKED ec_eeprom_cat_fmmu_t;
    
typedef struct eeprom_info {
    int read_eeprom;                        
 
    osal_uint32_t vendor_id;                
    osal_uint32_t product_code;             
    osal_uint16_t mbx_supported;            
 
    osal_uint16_t mbx_receive_offset;       
    osal_uint16_t mbx_receive_size;         
    osal_uint16_t mbx_send_offset;          
    osal_uint16_t mbx_send_size;            
    
    osal_uint16_t boot_mbx_receive_offset;  
    osal_uint16_t boot_mbx_receive_size;    
    osal_uint16_t boot_mbx_send_offset;     
    osal_uint16_t boot_mbx_send_size;       
 
    ec_eeprom_cat_general_t general;        
 
    osal_uint8_t strings_cnt;               
    osal_char_t strings[LEC_MAX_EEPROM_CAT_STRINGS][LEC_MAX_STRING_LEN];                  
 
    osal_uint8_t sms_cnt;                   
    ec_eeprom_cat_sm_t sms[LEC_MAX_EEPROM_CAT_SM];      
 
    osal_uint8_t fmmus_cnt;                 
    ec_eeprom_cat_fmmu_t fmmus[LEC_MAX_EEPROM_CAT_FMMU]; 
 
    ec_eeprom_cat_pdo_t free_pdos[LEC_MAX_EEPROM_CAT_PDO];  
    struct ec_eeprom_cat_pdo_queue free_pdo_queue;          
 
    struct ec_eeprom_cat_pdo_queue txpdos;  
    struct ec_eeprom_cat_pdo_queue rxpdos;  
 
    osal_uint8_t dcs_cnt;                   
    ec_eeprom_cat_dc_t dcs[LEC_MAX_EEPROM_CAT_DC];                
} eeprom_info_t;
 
#define EC_EEPROM_MBX_AOE                   (0x01u)     
#define EC_EEPROM_MBX_EOE                   (0x02u)     
#define EC_EEPROM_MBX_COE                   (0x04u)     
#define EC_EEPROM_MBX_FOE                   (0x08u)     
#define EC_EEPROM_MBX_SOE                   (0x10u)     
#define EC_EEPROM_MBX_VOE                   (0x20u)     
 
#define EC_EEPROM_ADR_VENDOR_ID             (0x0008u)   
#define EC_EEPROM_ADR_PRODUCT_CODE          (0x000Au)   
#define EC_EEPROM_ADR_BOOT_MBX_RECV_OFF     (0x0014u)   
#define EC_EEPROM_ADR_BOOT_MBX_RECV_SIZE    (0x0015u)   
#define EC_EEPROM_ADR_BOOT_MBX_SEND_OFF     (0x0016u)   
#define EC_EEPROM_ADR_BOOT_MBX_SEND_SIZE    (0x0017u)   
#define EC_EEPROM_ADR_STD_MBX_RECV_OFF      (0x0018u)   
#define EC_EEPROM_ADR_STD_MBX_RECV_SIZE     (0x0019u)   
#define EC_EEPROM_ADR_STD_MBX_SEND_OFF      (0x001Au)   
#define EC_EEPROM_ADR_STD_MBX_SEND_SIZE     (0x001Bu)   
#define EC_EEPROM_ADR_MBX_SUPPORTED         (0x001Cu)   
#define EC_EEPROM_ADR_SIZE                  (0x003Eu)   
#define EC_EEPROM_ADR_CAT_OFFSET            (0x0040u)   
 
#define EC_EEPROM_CAT_NOP                   (     0u)   
#define EC_EEPROM_CAT_STRINGS               (    10u)   
#define EC_EEPROM_CAT_DATATYPES             (    20u)   
#define EC_EEPROM_CAT_GENERAL               (    30u)   
#define EC_EEPROM_CAT_FMMU                  (    40u)   
#define EC_EEPROM_CAT_SM                    (    41u)   
#define EC_EEPROM_CAT_TXPDO                 (    50u)   
#define EC_EEPROM_CAT_RXPDO                 (    51u)   
#define EC_EEPROM_CAT_DC                    (    60u)   
#define EC_EEPROM_CAT_END                   (0xFFFFu)   
 
#ifdef __cplusplus
extern "C" {
#endif
 
// forward decl
struct ec;
 
 
int ec_eeprom_to_pdi(struct ec *pec, osal_uint16_t slave);
 
 
int ec_eeprom_to_ec(struct ec *pec, osal_uint16_t slave);
 
 
int ec_eepromread(struct ec *pec, osal_uint16_t slave, 
        osal_uint32_t eepadr, osal_uint32_t *data);
 
 
int ec_eepromwrite(struct ec *pec, osal_uint16_t slave, 
        osal_uint32_t eepadr, osal_uint16_t *data);
 
 
int ec_eepromread_len(struct ec *pec, osal_uint16_t slave, 
        osal_uint32_t eepadr, osal_uint8_t *buf, osal_size_t buflen);
 
 
int ec_eepromwrite_len(struct ec *pec, osal_uint16_t slave, 
        osal_uint32_t eepadr, const osal_uint8_t *buf, osal_size_t buflen);
 
 
void ec_eeprom_dump(struct ec *pec, osal_uint16_t slave);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBETHERCAT_EEPROM_H