IgH EtherCAT Master  1.5.3
sdo_request.h
Go to the documentation of this file.
1 /******************************************************************************
2  *
3  * Copyright (C) 2006-2023 Florian Pose, Ingenieurgemeinschaft IgH
4  *
5  * This file is part of the IgH EtherCAT Master.
6  *
7  * The IgH EtherCAT Master is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License version 2, as
9  * published by the Free Software Foundation.
10  *
11  * The IgH EtherCAT Master is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
14  * Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with the IgH EtherCAT Master; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19  *
20  * ---
21  *
22  * The license mentioned above concerns the source code only. Using the
23  * EtherCAT technology and brand is only permitted in compliance with the
24  * industrial property and similar rights of Beckhoff Automation GmbH.
25  *
26  *****************************************************************************/
27 
33 /*****************************************************************************/
34 
35 #ifndef __EC_SDO_REQUEST_H__
36 #define __EC_SDO_REQUEST_H__
37 
38 #include <linux/list.h>
39 
40 #include "globals.h"
41 
42 /*****************************************************************************/
43 
47  struct list_head list;
48  uint16_t index;
49  uint8_t subindex;
50  uint8_t *data;
51  size_t mem_size;
52  size_t data_size;
53  uint8_t complete_access;
54  uint32_t issue_timeout;
56  uint32_t response_timeout;
62  unsigned long jiffies_start;
63  unsigned long jiffies_sent;
65  int errno;
66  uint32_t abort_code;
67 };
68 
69 /*****************************************************************************/
70 
73 
76 int ec_sdo_request_copy_data(ec_sdo_request_t *, const uint8_t *, size_t);
78 
79 /*****************************************************************************/
80 
81 #endif
void ec_sdo_request_init(ec_sdo_request_t *)
SDO request constructor.
Definition: sdo_request.c:54
CANopen SDO request.
Definition: sdo_request.h:46
ec_internal_request_state_t state
SDO request state.
Definition: sdo_request.h:61
uint32_t response_timeout
Maximum time in ms, the transfer is retried, if the slave does not respond.
Definition: sdo_request.h:56
size_t mem_size
Size of SDO data memory.
Definition: sdo_request.h:51
uint16_t index
SDO index.
Definition: sdo_request.h:48
uint32_t abort_code
SDO request abort code.
Definition: sdo_request.h:66
void ec_sdo_request_clear(ec_sdo_request_t *)
SDO request destructor.
Definition: sdo_request.c:76
uint8_t * data
Pointer to SDO data.
Definition: sdo_request.h:50
int ec_sdo_request_timed_out(const ec_sdo_request_t *)
Checks, if the timeout was exceeded.
Definition: sdo_request.c:177
Global definitions and macros.
ec_direction_t dir
Direction.
Definition: sdo_request.h:58
ec_internal_request_state_t
Generic request state.
Definition: globals.h:278
unsigned long jiffies_sent
Jiffies, when the upload/download request was sent.
Definition: sdo_request.h:63
ec_direction_t
Direction type for PDO assignment functions.
Definition: ecrt.h:446
int errno
Error number.
Definition: sdo_request.h:65
int ec_sdo_request_copy_data(ec_sdo_request_t *, const uint8_t *, size_t)
Copies SDO data from an external source.
Definition: sdo_request.c:156
uint8_t subindex
SDO subindex.
Definition: sdo_request.h:49
size_t data_size
Size of SDO data.
Definition: sdo_request.h:52
int ec_sdo_request_copy(ec_sdo_request_t *, const ec_sdo_request_t *)
Copy another SDO request.
Definition: sdo_request.c:91
struct list_head list
List item.
Definition: sdo_request.h:47
uint32_t issue_timeout
Maximum time in ms, the processing of the request may take.
Definition: sdo_request.h:54
unsigned long jiffies_start
Jiffies, when the request was issued.
Definition: sdo_request.h:62
int ec_sdo_request_alloc(ec_sdo_request_t *, size_t)
Pre-allocates the data memory.
Definition: sdo_request.c:127
uint8_t complete_access
SDO shall be transferred completely.
Definition: sdo_request.h:53