net/caif/caif_device.h

0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  * Copyright (C) ST-Ericsson AB 2010
0004  * Author:  Sjur Brendeland
0005  */
0006
0007 #ifndef CAIF_DEVICE_H_
0008 #define CAIF_DEVICE_H_
0009 #include <linux/kernel.h>
0010 #include <linux/net.h>
0011 #include <linux/netdevice.h>
0012 #include <linux/caif/caif_socket.h>
0013 #include <net/caif/caif_device.h>
0014
0015 /**
0016  * struct caif_dev_common - data shared between CAIF drivers and stack.
0017  * @flowctrl:       Flow Control callback function. This function is
0018  *                      supplied by CAIF Core Stack and is used by CAIF
0019  *                      Link Layer to send flow-stop to CAIF Core.
0020  *                      The flow information will be distributed to all
0021  *                      clients of CAIF.
0022  *
0023  * @link_select:    Profile of device, either high-bandwidth or
0024  *          low-latency. This member is set by CAIF Link
0025  *          Layer Device in order to indicate if this device
0026  *          is a high bandwidth or low latency device.
0027  *
0028  * @use_frag:       CAIF Frames may be fragmented.
0029  *          Is set by CAIF Link Layer in order to indicate if the
0030  *          interface receives fragmented frames that must be
0031  *          assembled by CAIF Core Layer.
0032  *
0033  * @use_fcs:        Indicate if Frame CheckSum (fcs) is used.
0034  *          Is set if the physical interface is
0035  *          using Frame Checksum on the CAIF Frames.
0036  *
0037  * @use_stx:        Indicate STart of frame eXtension (stx) in use.
0038  *          Is set if the CAIF Link Layer expects
0039  *          CAIF Frames to start with the STX byte.
0040  *
0041  * This structure is shared between the CAIF drivers and the CAIF stack.
0042  * It is used by the device to register its behavior.
0043  * CAIF Core layer must set the member flowctrl in order to supply
0044  * CAIF Link Layer with the flow control function.
0045  *
0046  */
0047  struct caif_dev_common {
0048     void (*flowctrl)(struct net_device *net, int on);
0049     enum caif_link_selector link_select;
0050     int use_frag;
0051     int use_fcs;
0052     int use_stx;
0053 };
0054
0055 #endif  /* CAIF_DEVICE_H_ */