foe.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_FOE_H
#define LIBETHERCAT_FOE_H
 
#include <libosal/types.h>
 
#include "libethercat/common.h"
#include "libethercat/pool.h"
 
typedef struct ec_foe {
    pool_t recv_pool;                               
} ec_foe_t;
 
#define MAX_FILE_NAME_SIZE  512u                    
#define MAX_ERROR_TEXT_SIZE 512u                    
 
typedef struct ec_fw_update {
    osal_uint16_t cmd;                              
    osal_uint16_t size;                             
    osal_uint16_t address_low;                      
    osal_uint16_t address_high;                     
    osal_uint16_t data[(LEC_MAX_DATA-8u)>>1u];      
} ec_fw_update_t;
 
#define EC_FOE_OP_CODE_READ_REQUEST  0x01u          
#define EC_FOE_OP_CODE_WRITE_REQUEST 0x02u          
#define EC_FOE_OP_CODE_DATA_REQUEST  0x03u          
#define EC_FOE_OP_CODE_ACK_REQUEST   0x04u          
#define EC_FOE_OP_CODE_ERROR_REQUEST 0x05u          
#define EC_FOE_OP_CODE_BUSY_REQUEST  0x06u          
 
#define EC_FOE_ERROR_NOT_DEFINED         0x8000u    
#define EC_FOE_ERROR_NOT_FOUND           0x8001u    
#define EC_FOE_ERROR_ACCESS_DENIED       0x8002u    
#define EC_FOE_ERROR_DISK_FULL           0x8003u    
#define EC_FOE_ERROR_ILLEGAL             0x8004u    
#define EC_FOE_ERROR_PACKET_NUMBER_WRONG 0x8005u    
#define EC_FOE_ERROR_ALREADY_EXISTS      0x8006u    
#define EC_FOE_ERROR_NO_USER             0x8007u    
#define EC_FOE_ERROR_BOOTSTRAP_ONLY      0x8008u    
#define EC_FOE_ERROR_NOT_BOOTSTRAP       0x8009u    
#define EC_FOE_ERROR_NO_RIGHTS           0x800Au    
#define EC_FOE_ERROR_PROGRAM_ERROR       0x800Bu    
 
#define EFW_CMD_IGNORE                  0u          
#define EFW_CMD_MEMORY_TRANSFER         1u          
#define EFW_CMD_WRCODE                  2u          
#define EFW_CMD_CHK_DEVID               3u          
#define EFW_CMD_CHK_DEVICEID            3u          
#define EFW_CMD_CHKSUM                  4u          
#define EFW_CMD_WRCODECHKSUM            5u          
#define EFW_CMD_SET_DEVID               6u          
#define EFW_CMD_CHKSUMCHKSUM            6u          
#define EFW_CMD_BOOTCHKSUM              7u          
#define EFW_CMD_SET_EEPROM              10u         
 
// forward declarations
struct ec;
typedef struct ec ec_t;     
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
void ec_foe_init(ec_t *pec, osal_uint16_t slave);
 
 
void ec_foe_deinit(ec_t *pec, osal_uint16_t slave);
 
 
void ec_foe_enqueue(ec_t *pec, osal_uint16_t slave, pool_entry_t *p_entry);
 
 
int ec_foe_read(ec_t *pec, osal_uint16_t slave, osal_uint32_t password,
        osal_char_t file_name[MAX_FILE_NAME_SIZE], osal_uint8_t **file_data, 
        osal_size_t *file_data_len, const osal_char_t **error_message);
 
 
int ec_foe_write(ec_t *pec, osal_uint16_t slave, osal_uint32_t password,
        osal_char_t file_name[MAX_FILE_NAME_SIZE], osal_uint8_t *file_data, 
        osal_size_t file_data_len, const osal_char_t **error_message);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBETHERCAT_COE_H