1d18957dbSPavel Pisa /* 2d18957dbSPavel Pisa * CAN common CAN bus emulation support 3d18957dbSPavel Pisa * 4d18957dbSPavel Pisa * Copyright (c) 2013-2014 Jin Yang 5d18957dbSPavel Pisa * Copyright (c) 2014-2018 Pavel Pisa 6d18957dbSPavel Pisa * 7d18957dbSPavel Pisa * Initial development supported by Google GSoC 2013 from RTEMS project slot 8d18957dbSPavel Pisa * 9d18957dbSPavel Pisa * Permission is hereby granted, free of charge, to any person obtaining a copy 10d18957dbSPavel Pisa * of this software and associated documentation files (the "Software"), to deal 11d18957dbSPavel Pisa * in the Software without restriction, including without limitation the rights 12d18957dbSPavel Pisa * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 13d18957dbSPavel Pisa * copies of the Software, and to permit persons to whom the Software is 14d18957dbSPavel Pisa * furnished to do so, subject to the following conditions: 15d18957dbSPavel Pisa * 16d18957dbSPavel Pisa * The above copyright notice and this permission notice shall be included in 17d18957dbSPavel Pisa * all copies or substantial portions of the Software. 18d18957dbSPavel Pisa * 19d18957dbSPavel Pisa * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 20d18957dbSPavel Pisa * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 21d18957dbSPavel Pisa * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 22d18957dbSPavel Pisa * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 23d18957dbSPavel Pisa * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 24d18957dbSPavel Pisa * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 25d18957dbSPavel Pisa * THE SOFTWARE. 26d18957dbSPavel Pisa */ 27d18957dbSPavel Pisa 28d18957dbSPavel Pisa #ifndef NET_CAN_EMU_H 29d18957dbSPavel Pisa #define NET_CAN_EMU_H 30d18957dbSPavel Pisa 31*dc5e9ac7SMarkus Armbruster #include "qemu/queue.h" 32d18957dbSPavel Pisa #include "qom/object.h" 33d18957dbSPavel Pisa 34d18957dbSPavel Pisa /* NOTE: the following two structures is copied from <linux/can.h>. */ 35d18957dbSPavel Pisa 36d18957dbSPavel Pisa /* 37d18957dbSPavel Pisa * Controller Area Network Identifier structure 38d18957dbSPavel Pisa * 39d18957dbSPavel Pisa * bit 0-28 : CAN identifier (11/29 bit) 40d18957dbSPavel Pisa * bit 29 : error frame flag (0 = data frame, 1 = error frame) 41d18957dbSPavel Pisa * bit 30 : remote transmission request flag (1 = rtr frame) 42d18957dbSPavel Pisa * bit 31 : frame format flag (0 = standard 11 bit, 1 = extended 29 bit) 43d18957dbSPavel Pisa */ 44d18957dbSPavel Pisa typedef uint32_t qemu_canid_t; 45d18957dbSPavel Pisa 46d18957dbSPavel Pisa typedef struct qemu_can_frame { 47d18957dbSPavel Pisa qemu_canid_t can_id; /* 32 bit CAN_ID + EFF/RTR/ERR flags */ 48d18957dbSPavel Pisa uint8_t can_dlc; /* data length code: 0 .. 8 */ 49d18957dbSPavel Pisa uint8_t data[8] QEMU_ALIGNED(8); 50d18957dbSPavel Pisa } qemu_can_frame; 51d18957dbSPavel Pisa 52d18957dbSPavel Pisa /* Keep defines for QEMU separate from Linux ones for now */ 53d18957dbSPavel Pisa 54d18957dbSPavel Pisa #define QEMU_CAN_EFF_FLAG 0x80000000U /* EFF/SFF is set in the MSB */ 55d18957dbSPavel Pisa #define QEMU_CAN_RTR_FLAG 0x40000000U /* remote transmission request */ 56d18957dbSPavel Pisa #define QEMU_CAN_ERR_FLAG 0x20000000U /* error message frame */ 57d18957dbSPavel Pisa 58d18957dbSPavel Pisa #define QEMU_CAN_SFF_MASK 0x000007FFU /* standard frame format (SFF) */ 59d18957dbSPavel Pisa #define QEMU_CAN_EFF_MASK 0x1FFFFFFFU /* extended frame format (EFF) */ 60d18957dbSPavel Pisa 61d18957dbSPavel Pisa /** 62d18957dbSPavel Pisa * struct qemu_can_filter - CAN ID based filter in can_register(). 63d18957dbSPavel Pisa * @can_id: relevant bits of CAN ID which are not masked out. 64d18957dbSPavel Pisa * @can_mask: CAN mask (see description) 65d18957dbSPavel Pisa * 66d18957dbSPavel Pisa * Description: 67d18957dbSPavel Pisa * A filter matches, when 68d18957dbSPavel Pisa * 69d18957dbSPavel Pisa * <received_can_id> & mask == can_id & mask 70d18957dbSPavel Pisa * 71d18957dbSPavel Pisa * The filter can be inverted (QEMU_CAN_INV_FILTER bit set in can_id) or it can 72d18957dbSPavel Pisa * filter for error message frames (QEMU_CAN_ERR_FLAG bit set in mask). 73d18957dbSPavel Pisa */ 74d18957dbSPavel Pisa typedef struct qemu_can_filter { 75d18957dbSPavel Pisa qemu_canid_t can_id; 76d18957dbSPavel Pisa qemu_canid_t can_mask; 77d18957dbSPavel Pisa } qemu_can_filter; 78d18957dbSPavel Pisa 79d18957dbSPavel Pisa /* QEMU_CAN_INV_FILTER can be set in qemu_can_filter.can_id */ 80d18957dbSPavel Pisa #define QEMU_CAN_INV_FILTER 0x20000000U 81d18957dbSPavel Pisa 82d18957dbSPavel Pisa typedef struct CanBusClientState CanBusClientState; 83d18957dbSPavel Pisa typedef struct CanBusState CanBusState; 84d18957dbSPavel Pisa 85d18957dbSPavel Pisa typedef struct CanBusClientInfo { 86d18957dbSPavel Pisa int (*can_receive)(CanBusClientState *); 87d18957dbSPavel Pisa ssize_t (*receive)(CanBusClientState *, 88d18957dbSPavel Pisa const struct qemu_can_frame *frames, size_t frames_cnt); 89d18957dbSPavel Pisa } CanBusClientInfo; 90d18957dbSPavel Pisa 91d18957dbSPavel Pisa struct CanBusClientState { 92d18957dbSPavel Pisa CanBusClientInfo *info; 93d18957dbSPavel Pisa CanBusState *bus; 94d18957dbSPavel Pisa int link_down; 95d18957dbSPavel Pisa QTAILQ_ENTRY(CanBusClientState) next; 96d18957dbSPavel Pisa CanBusClientState *peer; 97d18957dbSPavel Pisa char *model; 98d18957dbSPavel Pisa char *name; 99d18957dbSPavel Pisa void (*destructor)(CanBusClientState *); 100d18957dbSPavel Pisa }; 101d18957dbSPavel Pisa 102d18957dbSPavel Pisa #define TYPE_CAN_BUS "can-bus" 103d18957dbSPavel Pisa #define CAN_BUS_CLASS(klass) \ 104d18957dbSPavel Pisa OBJECT_CLASS_CHECK(CanBusClass, (klass), TYPE_CAN_BUS) 105d18957dbSPavel Pisa #define CAN_BUS_GET_CLASS(obj) \ 106d18957dbSPavel Pisa OBJECT_GET_CLASS(CanBusClass, (obj), TYPE_CAN_BUS) 107d18957dbSPavel Pisa #define CAN_BUS(obj) \ 108d18957dbSPavel Pisa OBJECT_CHECK(CanBusState, (obj), TYPE_CAN_BUS) 109d18957dbSPavel Pisa 110d18957dbSPavel Pisa int can_bus_filter_match(struct qemu_can_filter *filter, qemu_canid_t can_id); 111d18957dbSPavel Pisa 112d18957dbSPavel Pisa int can_bus_insert_client(CanBusState *bus, CanBusClientState *client); 113d18957dbSPavel Pisa 114d18957dbSPavel Pisa int can_bus_remove_client(CanBusClientState *client); 115d18957dbSPavel Pisa 116d18957dbSPavel Pisa ssize_t can_bus_client_send(CanBusClientState *, 117d18957dbSPavel Pisa const struct qemu_can_frame *frames, 118d18957dbSPavel Pisa size_t frames_cnt); 119d18957dbSPavel Pisa 120d18957dbSPavel Pisa int can_bus_client_set_filters(CanBusClientState *, 121d18957dbSPavel Pisa const struct qemu_can_filter *filters, 122d18957dbSPavel Pisa size_t filters_cnt); 123d18957dbSPavel Pisa 124d18957dbSPavel Pisa #endif 125