/* SPDX-License-Identifier: ((GPL-2.0-only WITH Linux-syscall-note) OR BSD-3-Clause) */ /* * linux/can/isotp.h * * Definitions for ISO 15765-2 CAN transport protocol sockets * * Copyright (c) 2020 Volkswagen Group Electronic Research * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of Volkswagen nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * Alternatively, provided that this notice is retained in full, this * software may be distributed under the terms of the GNU General * Public License ("GPL") version 2, in which case the provisions of the * GPL apply INSTEAD OF those given above. * * The provided data structures and external interfaces from this code * are not restricted to be used by modules with a GPL compatible license. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH * DAMAGE. */ #ifndef _UAPI_CAN_ISOTP_H #define _UAPI_CAN_ISOTP_H #include <linux/types.h> #include <linux/can.h> #define SOL_CAN_ISOTP … /* for socket options affecting the socket (not the global system) */ #define CAN_ISOTP_OPTS … #define CAN_ISOTP_RECV_FC … /* sockopts to force stmin timer values for protocol regression tests */ #define CAN_ISOTP_TX_STMIN … /* use this time instead of value */ /* provided in FC from the receiver */ #define CAN_ISOTP_RX_STMIN … /* ignore received CF frames which */ /* timestamps differ less than val */ #define CAN_ISOTP_LL_OPTS … struct can_isotp_options { … }; struct can_isotp_fc_options { … }; struct can_isotp_ll_options { … }; /* flags for isotp behaviour */ #define CAN_ISOTP_LISTEN_MODE … #define CAN_ISOTP_EXTEND_ADDR … #define CAN_ISOTP_TX_PADDING … #define CAN_ISOTP_RX_PADDING … #define CAN_ISOTP_CHK_PAD_LEN … #define CAN_ISOTP_CHK_PAD_DATA … #define CAN_ISOTP_HALF_DUPLEX … #define CAN_ISOTP_FORCE_TXSTMIN … #define CAN_ISOTP_FORCE_RXSTMIN … #define CAN_ISOTP_RX_EXT_ADDR … #define CAN_ISOTP_WAIT_TX_DONE … #define CAN_ISOTP_SF_BROADCAST … #define CAN_ISOTP_CF_BROADCAST … #define CAN_ISOTP_DYN_FC_PARMS … /* protocol machine default values */ #define CAN_ISOTP_DEFAULT_FLAGS … #define CAN_ISOTP_DEFAULT_EXT_ADDRESS … #define CAN_ISOTP_DEFAULT_PAD_CONTENT … #define CAN_ISOTP_DEFAULT_FRAME_TXTIME … #define CAN_ISOTP_DEFAULT_RECV_BS … #define CAN_ISOTP_DEFAULT_RECV_STMIN … #define CAN_ISOTP_DEFAULT_RECV_WFTMAX … /* * Remark on CAN_ISOTP_DEFAULT_RECV_* values: * * We can strongly assume, that the Linux Kernel implementation of * CAN_ISOTP is capable to run with BS=0, STmin=0 and WFTmax=0. * But as we like to be able to behave as a commonly available ECU, * these default settings can be changed via sockopts. * For that reason the STmin value is intentionally _not_ checked for * consistency and copied directly into the flow control (FC) frame. */ /* link layer default values => make use of Classical CAN frames */ #define CAN_ISOTP_DEFAULT_LL_MTU … #define CAN_ISOTP_DEFAULT_LL_TX_DL … #define CAN_ISOTP_DEFAULT_LL_TX_FLAGS … /* * The CAN_ISOTP_DEFAULT_FRAME_TXTIME has become a non-zero value as * it only makes sense for isotp implementation tests to run without * a N_As value. As user space applications usually do not set the * frame_txtime element of struct can_isotp_options the new in-kernel * default is very likely overwritten with zero when the sockopt() * CAN_ISOTP_OPTS is invoked. * To make sure that a N_As value of zero is only set intentional the * value '0' is now interpreted as 'do not change the current value'. * When a frame_txtime of zero is required for testing purposes this * CAN_ISOTP_FRAME_TXTIME_ZERO u32 value has to be set in frame_txtime. */ #define CAN_ISOTP_FRAME_TXTIME_ZERO … #endif /* !_UAPI_CAN_ISOTP_H */
Codebase Browser
linux