View source for CANNY 5.2 duo, CAN Gateway Driver

== General Description ==

Using the CAN gateway driver you can to implement the high-speed asynchronous relaying of messages between the CAN hardware interfaces with optional filtering and altering particular CAN messages.

The CAN gateway driver allows you to realize individual processing of incoming CAN messages by configuring up to eight selection rules (selectors).

Each rule (selector) allows you to select CAN messages by the following user-defined properties:
* CAN interface number via which the message was coming to the controller;
* CAN ID of incoming message (CAN gateway selector value).

When some incoming CAN message hit the selector, the CAN gateway driver perform one of the following user-defined actions:
* relay the message to another CAN interface of the controller "as is", without any changes;
* modify the message, and then relay the modified message to another CAN interface of the controller;
* discard the message.

Modification of the message is performed by replacing using a bitmask any bits of the original message, including the values of its ID, length and byte of data.

Для всех сообщений, поступивших с определенного интерфейса CAN, но не удовлетворяющих признакам ни одного из включенных правил отбора шлюза возможно задать одно из следующих действий: 
* ретранслировать сообщение на другой интерфейс CAN контроллера без изменений;
* отбросить сообщение.


Для работы драйвера шлюза CAN необходимо задать конфигурацию драйверов обоих CAN-интерфейсов контроллера, при этом заданные для интерфейсов конфигурации CAN могут отличаться.


При включенном драйвере шлюза CAN, средствами пользовательской диаграммы возможно, используя регистры Драйвера CAN0 и Драйвера CAN1:
* отправлять сообщения через любой из CAN-интерфейсов контроллера в обычном режиме;
* получать сообщения CAN удовлетворяющие правилам отбора установленным для соответствующего интерфейса CAN драйвером шлюза CAN.


В процессе работы пользовательской диаграммы возможно многократно изменять любые параметры конфигурации драйвера шлюза CAN средствами пользовательской диаграммы, организуя таким образом, с некоторыми временными ограничениями, динамический режим работы шлюза.

== Driver's registers ==

Below is a description of the permissible values of the CAN gate driver control registers, which allow setting the controller operation parameters for high-speed asynchronous relaying of messages between the CAN hardware interfaces.

Common registers of the CAN gateway driver.
{|border="1" style="border-collapse:collapse;" align="left" width="100%"
|- align="center" valign="top"
!width="250px"|Register
!Expected values
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway driver enable register
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|&ge; 1
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|Enable the CAN gateway driver;
|- valign="top"
|width="70px" style="padding-left:0.5em;"|= 0
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|Disable the CAN gateway driver.
|}
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway configuration register
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|&ge; 1
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|Apply the new settings of the CAN gateway driver (see note);
|- valign="top"
|width="70px" style="padding-left:0.5em;"|= 0
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|Do not update the settings of the CAN gateway driver.
|}
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway filter enable for CANx interface
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|&ge; 1
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|switch on the filtering mode of the CAN gateway for the corresponding interface: relay to the second CAN interface of the controller and transmit only CAN messages that are accepted by the gateway selections, the remaining messages are discarded;
|- valign="top"
|width="70px" style="padding-left:0.5em;"|= 0
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|the filtering mode of the CAN gateway for the corresponding interface is disabled: it automatically retransmits messages that have not entered the gateway selections to the second CAN-interface of the controller in unchanged form.
|}
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway logging mode enable for CANx interface
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|&ge; 1
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|enable the CAN gateway logging mode for the corresponding interface: transmit to the function chart (in the CAN driver) all CAN messages received on this interface.  The gateway driver will select, replace and relay CAN messages according to the corresponding gateway settings of the specified CAN interface;
|- valign="top"
|width="70px" style="padding-left:0.5em;"|= 0
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|disable the CAN gateway logging mode for the corresponding interface: only CAN messages that are included in the gateway's selections are transmitted to the diagram (in the CAN driver), the remaining messages are discarded.
|}
|}


CAN gateway configuration registers.

Common CAN gateway driver selection registers.

{|border="1" style="border-collapse:collapse;" align="left" width="100%"
|- align="center" valign="top"
!width="250px"|Registers
!Expected values
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway selector X enable register
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|&ge; 1
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|enable the appropriate selection of the CAN gateway;
|- valign="top"
|width="70px" style="padding-left:0.5em;"|= 0
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|the corresponding CAN gateway selection is disabled.
|}
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway selector X linked CAN interface number register
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|= 0
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|apply the appropriate selection to the messages coming to the controller via the CAN0 interface;
|- valign="top"
|width="70px" style="padding-left:0.5em;"|= 1
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|apply the appropriate selection to the messages coming to the controller via the CAN1 interface.
|}
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway excluding mode register for CANx interface
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|&ge; 1
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|discard all messages which match an enabled selection;
|- valign="top"
|width="70px" style="padding-left:0.5em;"|= 0
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|allow processing and automatic retransmission to another CAN interface of all messages which match an enabled selection.
|}
|}


CAN gateway selection registers.

'''''The value of the selection''''' - is a parameter which, when satisfied, selects an incoming CAN message for special processing.

{|border="1" style="border-collapse:collapse;" align="left" width="100%"
|- align="center" valign="top"
!width="250px"|Register
!Expected value
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway selector X value, IDL
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|0...0xFFFF
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|the value of the lower part of the identifier (bits 0 ... 10 of the standard format identifier or bits 0 ... 15 of the extended format identifier) of the CAN message the selection will accept.
|}
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway selector X value, IDH
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|0...0x1FFF
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|the value of the highest part of the identifier (bits 16 ... 28 of the extended format identifier) of the CAN message the selection will accept.
|}
|}


The registers of the gateway driver selection masks.

'''''The selection masks''''' - is a group of values whose bits define the bitwise modifications to be made when the gateway retransmits a part of the message that has been accepted by the appropriate selection. If the value of the mask bit is "0", the corresponding bit of the received message will be relayed to the other interface without changes. If the value of the mask bit is "1", the corresponding bit of the received message will be replaced by a corresponding bit from the value of the ''Substitution Substitution''

{|border="1" style="border-collapse:collapse;" align="left" width="100%"
|- align="center" valign="top"
!width="250px"|Register
!Expected value
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway selector X mask setup register, IDL
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|0...0xFFFF
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|set the value of the mask of the lower part of the CAN message identifier (bits 0 ... 10 of the standard format identifier or bits 0 ... 15 of the extended format identifier) of the corresponding selection.
|}
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway selector X mask setup register, IDH
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|0...0x1FFF
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|set the mask value of the upper part of the CAN message identifier (bits 16 ... 28 of the extended format identifier) of the appropriate selection.
|}
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway selector X mask setup register, ERL
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|0...0xFFFF
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|Set the mask value of the ERL register of the CAN message of the appropriate selection.
|}
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway selector X mask setup register, CAN D1:D0
|- valign="top"
|style="padding-left:0.5em;"|...
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway selector X mask setup register, CAN D7:D6
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|0...0xFFFF
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|set the value of the mask for the corresponding byte of data of the CAN message of the corresponding selection.
|}
|}


Registers for replacing the selections of the CAN gateway driver.

'''''Replacement of selection''''' - is a group of values whose bits replace the original bits in the retransmitted message that has fallen into the appropriate selection. If the value of the replacement bit is "0", the corresponding bit of the relayed message will be replaced by zero, with the replacement bit value equal to "1", the corresponding bit of the relayed message will be replaced by one. '''The replacement will only be applied to those bits whose selection mask value is "1".'''

{|border="1" style="border-collapse:collapse;" align="left" width="100%"
|- align="center" valign="top"
!width="250px"|Register
!Expected value
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway selector X replace setup register, CAN IDL
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|0...0xFFFF
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|set the value of the replacement of the lower part of the CAN message identifier (bits 0 ... 10 of the standard format identifier or bits 0 ... 15 of the extended format identifier) of the corresponding selection.
|}
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway selector X replace setup register, CAN IDH
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|0...0x1FFF
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|set the value of the replacement of the highest part of the CAN message identifier (bits 16 ... 28 of the extended format identifier) of the corresponding selection.
|}
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway selector X replace setup register, CAN ERL
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|0...0xFFFF
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|set the replacement value of the ERL register of the CAN message of the selection being used.
|}
|- valign="top"
|
{|border="0" align="left"
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway selector X replace setup register, CAN D1:D0
|- valign="top"
|style="padding-left:0.5em;"|...
|- valign="top"
|style="padding-left:0.5em;"|CAN gateway selector X replace setup register, CAN D7:D6
|}
|valign="top"|
{|border="0" align="left"
|- valign="top"
|width="70px" style="padding-left:0.5em;"|0...0xFFFF
|style="padding-left:0.5em;"|=
|style="padding-left:0.5em;"|set the replacement values of the corresponding data bytes of the CAN message of the corresponding selection.
|}
|}
<br clear="all">

== Блок-схема работы контроллера в режиме CAN-шлюза ==

[[Изображение:14_8_2_1.png|800px]]

<!--NOPDF-->
== See also ==
[[CANNY 5.2 duo]]

[[CANNY 5.2 duo, CAN Driver]]

<!--/NOPDF-->