irj45 user manual
port GmbH
Regensburger Str. 7
D-06132 Halle/Saale
Disclaimer
This manual represents the current state of the product. Please check with port.de for the latest version as the document may have a newer version since errors may be corrected or changes for a newer version of the product may be incorporated. Port.de assumes no responsibility for errors in this document. Qualified feedback is appreciated at service@port.de.
This document is the Intellectual Property of port.de and is intended to be used with the described product only. It may be forwarded and/or copied in the original and unmodified format. All rights reserved.
The product enables to use technologies such as PROFINET, EtherNet/IP and/or EtherCAT and others. These technologies are promoted by trade organizations, such as PNO (profibus.org), ODVA (odva.org) or ETG (ethercat.org). These trade organizations as well maintain the specification and care about legal issues.
We strongly recommend to become a member of these organisations. Most technologies are making use of patented or otherwise copyrighted technologies, approaches or other intellectual property. The membership usually automatically entitles the member for use of most of the technology-inherent copyrighted or otherwise protected Intellectual Property of the corresponding trade organization and most 3rd parties. Otherwise the user will need to obtain licenses for many patented technologies separately.
Further we suggest to you to subscribe to the corresponding Conformance Test Tool of these trade organizations. For instance the ODVA only accepts conformance test applications from companies who have a valid membership and have a valid subscription to the recent Conformance Test Tool. We as port are members in all corresponding organizations and are holding a subscription to these tools - however you as a customer need to have an own membership and an own subscription to the tool.
All rights reserved
The programs, boards and documentations supplied by port GmbH are created with due diligence, checked carefully and tested on several applications.
Nevertheless, port GmbH cannot guarantee and nor assume liability that the program, the hardware board or the documentation are error-free or appropriate to serve a specific customer purpose. In particular performance characteristics and technical data given in this document may not be interpreted to be guaranteed product features in any legal sense.
For consequential damages, every legal responsibility or liability is excluded.
port has the right to modify the products described or their documentation at any time without prior warning, as long as these changes are made for reasons of reliability or technical improvement.
All rights of this documentation are with port. Unless expressively granted - the transfer of rights to third parties or duplication of this document in any form, whole or in part, is subject to written approval by port. Copies of this document may however be made exclusively for the use of the user and his engineers. The user is thereby responsible that third parties do not obtain access to these copies.
The soft- and hardware designations used are mostly registered and are subject to copyright.
Copyright
© 2019 port GmbH
Regensburger Straße 7
D-06132 Halle
Tel. +49 345 - 777 55 0
Fax. +49 345 - 777 55 20
E-Mail service@port.de
www.port.de
www.port-automation.com
Contents
1 Introduction
2 Document structure
3 Device architecture
3.1 Architecture
3.2 Interface
3.2.1 Hardware interface
3.2.2 Software Interface
3.2.3 Integration of communication layers / middleware
4 Application
4.1 Introduction
4.2 Hardware setup
4.3 Basic application setup
4.4 Default Features
4.5 Features
4.5.1 Device Detection
4.5.2 PNIO
4.5.3 EtherNet/IP
4.5.4 EtherCAT
4.5.5 HTTPD
4.5.6 Network channels
4.5.7 Generic Data Provider
4.5.8 Ethernet Startup Delay
4.6 External Reset
4.7 RPC Synchronization reset
4.7.1 CC
4.7.2 AC
4.8 IP Settings
4.9 Management Interface CC
4.9.1 Management Interface DD
4.9.2 PNIO
4.9.3 LM
4.9.4 NET
4.9.5 BOOT
4.9.6 CM
4.9.7 ETH
4.9.8 EIP
4.9.9 HTTPD
4.9.10 CCM
4.10 Firmware Update
4.10.1 Update the communication controller
4.10.2 Update possibilities for application controller
5 Communication stack
5.1 SPI Data Exchange
5.1.1 Clock domains and communication cycle
5.1.2 Technical data
5.1.3 SPI Timing
5.1.4 SPI Frame Structure
5.2 Remote Procedure Call
5.2.1 RPC Frame Structure
5.2.2 RPC Synchronization
5.2.3 RPC Protocol
5.3 GOAL PROFINET Data Mapper API
5.3.1 Map Subslot Data – goal_pnioDmSubslotAdd
5.3.2 Map Subslot IOCS/IOPS - goal_pnioDmSubslotIoxsAdd
5.3.3 Map APDU Status – goal_pnioDmApduAdd
5.3.4 Map Data Provider Status – goal_pnioDmDpAdd
6 Application Programming Interface
6.1 device specific functions
6.1.1 appl_ccmRpcInit
6.1.2 appl_ccmUpdateAllow
6.1.3 appl_ccmUpdateDeny
6.1.4 appl_ccmInfo
6.1.5 appl_ccmFaultStateSet
6.1.6 appl_ccmCommResetSet
6.1.7 appl_ccmLogEnable
6.1.8 appl_ccmLogToAcEnable
6.1.9 appl_ccmFwUpdateStart
6.1.10 appl_ccmFwUpdateExecute
6.1.11 appl_ccmEcatSsiUpdate
6.1.12 appl_ccmEthMacAddressSet
6.1.13 appl_ccmNetworkDefaultUp
6.1.14 appl_ccmNetworkEoEUp
6.1.15 appl_ccmCfgVarGet
6.1.16 appl_ccmCfgVarSet
6.1.17 appl_ccmCfgSave
6.2 Device Detection
6.2.1 goal_ddInit - Register GOAL dd API in GOAL (appl_init)
6.2.2 goal_ddNew - Register GOAL dd API in GOAL (appl_setup)
6.2.3 goal_ddCustomerIdSet
6.2.4 goal_ddModuleNameSet
6.2.5 goal_ddFeaturesSet
6.2.6 goal_ddCallbackReg
6.2.7 goal_ddSessionFeatureActivate
6.2.8 goal_ddFilterAdd
6.3 profinet stack
6.4 ethernet ip stack
6.5 EtherCAT stack
6.6 web server
6.7 networking
6.7.1 goal_netRpcInit
6.8 goal_maNetOpen - open network channel
6.8.1 goal_maNetClose - close network
6.8.2 goal_maNetGetById - get network MA handle
6.8.3 goal_maNetIpSet – set ip address
6.9 tcp channel
6.9.1 goal_maChanTcpOpen - open the tcp channel MA
6.9.2 goal_maChanTcpNew - create a new tcp channel
6.9.3 goal_maChanTcpActive - activate a created tcp channel
6.9.4 goal_maChanTcpSetNonBlocking - set channel to non blocking
6.9.5 goal_maChanTcpGetRemoteAddr - get remote address of tcp channel
6.9.6 goal_maChanTcpSend - send data through tcp channel
6.10 udp channel
6.10.1 goal_maChanUdpOpen - open the udp channel MA
6.10.2 goal_maChanUdpGetById - get the udp channel MA handle
6.10.3 goal_maChanUdpNew - create a new udp channel
6.10.4 goal_maChanUdpClose - close the udp channel MA
6.10.5 goal_maChanUdpSetNonBlocking - set the opened channel to non blocking access
6.10.6 goal_maChanUdpSetBroadcast - set the opened udp channel to broadcast operation
6.10.7 goal_maChanUdpGetRemoteAddr - get remote address of the udp channel
6.10.8 goal_maChanUdpActivate - acticate a udp channel
6.10.9 goal_maChanUdpSend - send data to the udp channel
7 Examples
7.1 01_pnio_io_mirror
7.1.1 Purpose
7.1.2 Configuration
7.1.3 Usage Hints
7.2 01_pnio_io_mirror_renesas
7.3 02_eip_io_data
7.3.1 Purpose
7.3.2 Configuration
7.3.3 Usage Hints
7.4 02_eip_io_data_renesas
7.5 05_pnio_01_simple_io
7.5.1 Purpose
7.5.2 Configuration
7.5.3 Usage Hints
7.6 05_pnio_01_simple_io_renesas
7.7 06_eip_io_data_static_ip
7.7.1 Configuration
7.7.2 Usage Hints
7.8 07_pnio_dsn
7.8.1 Purpose
7.8.2 Configuration
7.8.3 Usage Hints
7.9 10_pnio_process_alarm
7.9.1 Purpose
7.9.2 Configuration
7.9.3 Usage Hints
7.10 09_ecat_slave
7.10.1 Purpose
7.10.2 Configuration
7.10.3 Usage Hints
7.11 11_firmware_update
7.11.1 Purpose
7.11.2 Usage Hints
7.12 13_firmware_update_callback
7.12.1 Purpose
7.12.2 Configuration
7.12.3 Usage Hints
7.13 http_01_get
7.13.1 Purpose
7.13.2 Configuration
7.13.3 Usage Hints
7.14 http_02_post
7.14.1 Purpose
7.14.2 Configuration
7.14.3 Usage Hints
7.15 http_03_list_res
7.15.1 Purpose
7.15.2 Configuration
7.15.3 Usage Hints
7.16 http_04_auth
7.16.1 Configuration
7.16.2 Usage Hints
7.17 http_05_template_cm
7.17.1 Purpose
7.17.2 Configuration
7.17.3 Usage Hints
7.18 http_06_template_list
7.18.1 Configuration
7.18.2 Usage Hints
7.19 http_07_template_table
7.19.1 Purpose
7.19.2 Configuration
7.19.3 Usage Hints
7.20 net_01_udp_receive
7.20.1 Purpose
7.20.2 Configuration
7.20.3 Usage Hints
7.21 net_02_tcp_client
7.21.1 Purpose
7.21.2 Configuration
7.21.3 Usage Hints
7.22 net_03_tcp_server
7.22.1 Purpose
7.22.2 Configuration
7.22.3 Usage Hints
8 Trouble Shooting
8.1 Startup Issues
8.2 Connection issues
8.3 IP configuration
8.4 Downgrade to version 1.0
9 Targets
9.1 RENESAS Synergy
9.1.1 Development Environment
9.1.2 Supported Hardware
9.1.3 Adaption for customer hardware
9.1.4 Logging
9.2 STM32
9.2.1 Development Environment
9.2.2 Supported Hardware
9.2.3 Adaption to customer hardware
9.2.4 Logging
9.3 Raspberry Pi
9.3.1 Development Environment
9.3.2 Supported Hardware
9.3.3 Adaption to customer hardware
9.3.4 Logging
Table of figures
Figure 1 ctc clock domains
Figure 2 Communication Cycle
Figure 3 Basic SPI timing
Figure 4 e2studio SPI properties
Figure 5 e2studio SPI pinning
Figure 6 ThreadX configuration
Changelog
Version |
Changes |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|