mirror of
https://gitee.com/bianbu-linux/linux-6.6
synced 2025-06-29 23:43:21 -04:00
383f0993fc
Currently, the CAN netlink interface provides no easy ways to check the capabilities of a given controller. The only method from the command line is to try each CAN_CTRLMODE_* individually to check whether the netlink interface returns an -EOPNOTSUPP error or not (alternatively, one may find it easier to directly check the source code of the driver instead...) This patch introduces a method for the user to check both the supported and the static capabilities. The proposed method introduces a new IFLA nest: IFLA_CAN_CTRLMODE_EXT which extends the current IFLA_CAN_CTRLMODE. This is done to guaranty a full forward and backward compatibility between the kernel and the user land applications. The IFLA_CAN_CTRLMODE_EXT nest contains one single entry: IFLA_CAN_CTRLMODE_SUPPORTED. Because this entry is only used in one direction: kernel to userland, no new struct nla_policy are introduced. Below table explains how IFLA_CAN_CTRLMODE_SUPPORTED (hereafter: "supported") and can_ctrlmode::flags (hereafter: "flags") allow us to identify both the supported and the static capabilities, when masked with any of the CAN_CTRLMODE_* bit flags: supported & flags & Controller capabilities CAN_CTRLMODE_* CAN_CTRLMODE_* ----------------------------------------------------------------------- false false Feature not supported (always disabled) false true Static feature (always enabled) true false Feature supported but disabled true true Feature supported and enabled Link: https://lore.kernel.org/all/20211213160226.56219-5-mailhol.vincent@wanadoo.fr Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr> Signed-off-by: Marc Kleine-Budde <mkl@pengutronix.de>
185 lines
5 KiB
C
185 lines
5 KiB
C
/* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */
|
|
/*
|
|
* linux/can/netlink.h
|
|
*
|
|
* Definitions for the CAN netlink interface
|
|
*
|
|
* Copyright (c) 2009 Wolfgang Grandegger <wg@grandegger.com>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the version 2 of the GNU General Public License
|
|
* as published by the Free Software Foundation
|
|
*
|
|
* This program 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 General Public License for more details.
|
|
*/
|
|
|
|
#ifndef _UAPI_CAN_NETLINK_H
|
|
#define _UAPI_CAN_NETLINK_H
|
|
|
|
#include <linux/types.h>
|
|
|
|
/*
|
|
* CAN bit-timing parameters
|
|
*
|
|
* For further information, please read chapter "8 BIT TIMING
|
|
* REQUIREMENTS" of the "Bosch CAN Specification version 2.0"
|
|
* at http://www.semiconductors.bosch.de/pdf/can2spec.pdf.
|
|
*/
|
|
struct can_bittiming {
|
|
__u32 bitrate; /* Bit-rate in bits/second */
|
|
__u32 sample_point; /* Sample point in one-tenth of a percent */
|
|
__u32 tq; /* Time quanta (TQ) in nanoseconds */
|
|
__u32 prop_seg; /* Propagation segment in TQs */
|
|
__u32 phase_seg1; /* Phase buffer segment 1 in TQs */
|
|
__u32 phase_seg2; /* Phase buffer segment 2 in TQs */
|
|
__u32 sjw; /* Synchronisation jump width in TQs */
|
|
__u32 brp; /* Bit-rate prescaler */
|
|
};
|
|
|
|
/*
|
|
* CAN hardware-dependent bit-timing constant
|
|
*
|
|
* Used for calculating and checking bit-timing parameters
|
|
*/
|
|
struct can_bittiming_const {
|
|
char name[16]; /* Name of the CAN controller hardware */
|
|
__u32 tseg1_min; /* Time segment 1 = prop_seg + phase_seg1 */
|
|
__u32 tseg1_max;
|
|
__u32 tseg2_min; /* Time segment 2 = phase_seg2 */
|
|
__u32 tseg2_max;
|
|
__u32 sjw_max; /* Synchronisation jump width */
|
|
__u32 brp_min; /* Bit-rate prescaler */
|
|
__u32 brp_max;
|
|
__u32 brp_inc;
|
|
};
|
|
|
|
/*
|
|
* CAN clock parameters
|
|
*/
|
|
struct can_clock {
|
|
__u32 freq; /* CAN system clock frequency in Hz */
|
|
};
|
|
|
|
/*
|
|
* CAN operational and error states
|
|
*/
|
|
enum can_state {
|
|
CAN_STATE_ERROR_ACTIVE = 0, /* RX/TX error count < 96 */
|
|
CAN_STATE_ERROR_WARNING, /* RX/TX error count < 128 */
|
|
CAN_STATE_ERROR_PASSIVE, /* RX/TX error count < 256 */
|
|
CAN_STATE_BUS_OFF, /* RX/TX error count >= 256 */
|
|
CAN_STATE_STOPPED, /* Device is stopped */
|
|
CAN_STATE_SLEEPING, /* Device is sleeping */
|
|
CAN_STATE_MAX
|
|
};
|
|
|
|
/*
|
|
* CAN bus error counters
|
|
*/
|
|
struct can_berr_counter {
|
|
__u16 txerr;
|
|
__u16 rxerr;
|
|
};
|
|
|
|
/*
|
|
* CAN controller mode
|
|
*/
|
|
struct can_ctrlmode {
|
|
__u32 mask;
|
|
__u32 flags;
|
|
};
|
|
|
|
#define CAN_CTRLMODE_LOOPBACK 0x01 /* Loopback mode */
|
|
#define CAN_CTRLMODE_LISTENONLY 0x02 /* Listen-only mode */
|
|
#define CAN_CTRLMODE_3_SAMPLES 0x04 /* Triple sampling mode */
|
|
#define CAN_CTRLMODE_ONE_SHOT 0x08 /* One-Shot mode */
|
|
#define CAN_CTRLMODE_BERR_REPORTING 0x10 /* Bus-error reporting */
|
|
#define CAN_CTRLMODE_FD 0x20 /* CAN FD mode */
|
|
#define CAN_CTRLMODE_PRESUME_ACK 0x40 /* Ignore missing CAN ACKs */
|
|
#define CAN_CTRLMODE_FD_NON_ISO 0x80 /* CAN FD in non-ISO mode */
|
|
#define CAN_CTRLMODE_CC_LEN8_DLC 0x100 /* Classic CAN DLC option */
|
|
#define CAN_CTRLMODE_TDC_AUTO 0x200 /* CAN transiver automatically calculates TDCV */
|
|
#define CAN_CTRLMODE_TDC_MANUAL 0x400 /* TDCV is manually set up by user */
|
|
|
|
/*
|
|
* CAN device statistics
|
|
*/
|
|
struct can_device_stats {
|
|
__u32 bus_error; /* Bus errors */
|
|
__u32 error_warning; /* Changes to error warning state */
|
|
__u32 error_passive; /* Changes to error passive state */
|
|
__u32 bus_off; /* Changes to bus off state */
|
|
__u32 arbitration_lost; /* Arbitration lost errors */
|
|
__u32 restarts; /* CAN controller re-starts */
|
|
};
|
|
|
|
/*
|
|
* CAN netlink interface
|
|
*/
|
|
enum {
|
|
IFLA_CAN_UNSPEC,
|
|
IFLA_CAN_BITTIMING,
|
|
IFLA_CAN_BITTIMING_CONST,
|
|
IFLA_CAN_CLOCK,
|
|
IFLA_CAN_STATE,
|
|
IFLA_CAN_CTRLMODE,
|
|
IFLA_CAN_RESTART_MS,
|
|
IFLA_CAN_RESTART,
|
|
IFLA_CAN_BERR_COUNTER,
|
|
IFLA_CAN_DATA_BITTIMING,
|
|
IFLA_CAN_DATA_BITTIMING_CONST,
|
|
IFLA_CAN_TERMINATION,
|
|
IFLA_CAN_TERMINATION_CONST,
|
|
IFLA_CAN_BITRATE_CONST,
|
|
IFLA_CAN_DATA_BITRATE_CONST,
|
|
IFLA_CAN_BITRATE_MAX,
|
|
IFLA_CAN_TDC,
|
|
IFLA_CAN_CTRLMODE_EXT,
|
|
|
|
/* add new constants above here */
|
|
__IFLA_CAN_MAX,
|
|
IFLA_CAN_MAX = __IFLA_CAN_MAX - 1
|
|
};
|
|
|
|
/*
|
|
* CAN FD Transmitter Delay Compensation (TDC)
|
|
*
|
|
* Please refer to struct can_tdc_const and can_tdc in
|
|
* include/linux/can/bittiming.h for further details.
|
|
*/
|
|
enum {
|
|
IFLA_CAN_TDC_UNSPEC,
|
|
IFLA_CAN_TDC_TDCV_MIN, /* u32 */
|
|
IFLA_CAN_TDC_TDCV_MAX, /* u32 */
|
|
IFLA_CAN_TDC_TDCO_MIN, /* u32 */
|
|
IFLA_CAN_TDC_TDCO_MAX, /* u32 */
|
|
IFLA_CAN_TDC_TDCF_MIN, /* u32 */
|
|
IFLA_CAN_TDC_TDCF_MAX, /* u32 */
|
|
IFLA_CAN_TDC_TDCV, /* u32 */
|
|
IFLA_CAN_TDC_TDCO, /* u32 */
|
|
IFLA_CAN_TDC_TDCF, /* u32 */
|
|
|
|
/* add new constants above here */
|
|
__IFLA_CAN_TDC,
|
|
IFLA_CAN_TDC_MAX = __IFLA_CAN_TDC - 1
|
|
};
|
|
|
|
/*
|
|
* IFLA_CAN_CTRLMODE_EXT nest: controller mode extended parameters
|
|
*/
|
|
enum {
|
|
IFLA_CAN_CTRLMODE_UNSPEC,
|
|
IFLA_CAN_CTRLMODE_SUPPORTED, /* u32 */
|
|
|
|
/* add new constants above here */
|
|
__IFLA_CAN_CTRLMODE,
|
|
IFLA_CAN_CTRLMODE_MAX = __IFLA_CAN_CTRLMODE - 1
|
|
};
|
|
|
|
/* u16 termination range: 1..65535 Ohms */
|
|
#define CAN_TERMINATION_DISABLED 0
|
|
|
|
#endif /* !_UAPI_CAN_NETLINK_H */
|