Commit 6bdd533c authored by Sean Young's avatar Sean Young Committed by Daniel Borkmann
Browse files

bpf: add selftest for lirc_mode2 type program 



This is simple test over rc-loopback.

Acked-by: default avatarYonghong Song <yhs@fb.com>
Signed-off-by: default avatarSean Young <sean@mess.org>
Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
parent f4364dcf

tools/bpf/bpftool/prog.c

+1 −0
Original line number Diff line number Diff line
@@ -71,6 +71,7 @@ static const char * const prog_type_name[] = { 
	[BPF_PROG_TYPE_SK_MSG]		= "sk_msg",

	[BPF_PROG_TYPE_RAW_TRACEPOINT]	= "raw_tracepoint",

	[BPF_PROG_TYPE_CGROUP_SOCK_ADDR] = "cgroup_sock_addr",

	[BPF_PROG_TYPE_LIRC_MODE2]	= "lirc_mode2",

};



static void print_boot_time(__u64 nsecs, char *buf, unsigned int size)

tools/include/uapi/linux/bpf.h

+65 −14
Original line number Diff line number Diff line
@@ -143,6 +143,7 @@ enum bpf_prog_type { 
	BPF_PROG_TYPE_RAW_TRACEPOINT,

	BPF_PROG_TYPE_CGROUP_SOCK_ADDR,

	BPF_PROG_TYPE_LWT_SEG6LOCAL,

	BPF_PROG_TYPE_LIRC_MODE2,

};



enum bpf_attach_type {
@@ -162,6 +163,7 @@ enum bpf_attach_type { 
	BPF_CGROUP_INET6_POST_BIND,

	BPF_CGROUP_UDP4_SENDMSG,

	BPF_CGROUP_UDP6_SENDMSG,

	BPF_LIRC_MODE2,

	__MAX_BPF_ATTACH_TYPE

};
@@ -1852,10 +1854,10 @@ union bpf_attr { 
 *		If lookup is successful and result shows packet is to be

 *		forwarded, the neighbor tables are searched for the nexthop.

 *		If successful (ie., FIB lookup shows forwarding and nexthop

 *		is resolved), the nexthop address is returned in ipv4_dst,

 *		ipv6_dst or mpls_out based on family, smac is set to mac

 *		address of egress device, dmac is set to nexthop mac address,

 *		rt_metric is set to metric from route.

 *		is resolved), the nexthop address is returned in ipv4_dst

 *		or ipv6_dst based on family, smac is set to mac address of

 *		egress device, dmac is set to nexthop mac address, rt_metric

 *		is set to metric from route (IPv4/IPv6 only).

 *

 *             *plen* argument is the size of the passed in struct.

 *             *flags* argument can be a combination of one or more of the
@@ -2005,6 +2007,53 @@ union bpf_attr { 
 * 		direct packet access.

 *	Return

 * 		0 on success, or a negative error in case of failure.

 *

 * int bpf_rc_keydown(void *ctx, u32 protocol, u64 scancode, u32 toggle)

 *	Description

 *		This helper is used in programs implementing IR decoding, to

 *		report a successfully decoded key press with *scancode*,

 *		*toggle* value in the given *protocol*. The scancode will be

 *		translated to a keycode using the rc keymap, and reported as

 *		an input key down event. After a period a key up event is

 *		generated. This period can be extended by calling either

 *		**bpf_rc_keydown** () again with the same values, or calling

 *		**bpf_rc_repeat** ().

 *

 *		Some protocols include a toggle bit, in case the button	was

 *		released and pressed again between consecutive scancodes.

 *

 *		The *ctx* should point to the lirc sample as passed into

 *		the program.

 *

 *		The *protocol* is the decoded protocol number (see

 *		**enum rc_proto** for some predefined values).

 *

 *		This helper is only available is the kernel was compiled with

 *		the **CONFIG_BPF_LIRC_MODE2** configuration option set to

 *		"**y**".

 *

 *	Return

 *		0

 *

 * int bpf_rc_repeat(void *ctx)

 *	Description

 *		This helper is used in programs implementing IR decoding, to

 *		report a successfully decoded repeat key message. This delays

 *		the generation of a key up event for previously generated

 *		key down event.

 *

 *		Some IR protocols like NEC have a special IR message for

 *		repeating last button, for when a button is held down.

 *

 *		The *ctx* should point to the lirc sample as passed into

 *		the program.

 *

 *		This helper is only available is the kernel was compiled with

 *		the **CONFIG_BPF_LIRC_MODE2** configuration option set to

 *		"**y**".

 *

 *	Return

 *		0

 */

#define __BPF_FUNC_MAPPER(FN)		\

	FN(unspec),			\
@@ -2083,7 +2132,9 @@ union bpf_attr { 
	FN(lwt_push_encap),		\

	FN(lwt_seg6_store_bytes),	\

	FN(lwt_seg6_adjust_srh),	\

	FN(lwt_seg6_action),

	FN(lwt_seg6_action),		\

	FN(rc_repeat),			\

	FN(rc_keydown),



/* integer value in 'imm' field of BPF_CALL instruction selects which helper

 * function eBPF program intends to call
@@ -2537,8 +2588,10 @@ struct bpf_raw_tracepoint_args { 
#define BPF_FIB_LOOKUP_OUTPUT  BIT(1)



struct bpf_fib_lookup {

	/* input */

	__u8	family;   /* network family, AF_INET, AF_INET6, AF_MPLS */

	/* input:  network family for lookup (AF_INET, AF_INET6)

	 * output: network family of egress nexthop

	 */

	__u8	family;



	/* set if lookup is to consider L4 data - e.g., FIB rules */

	__u8	l4_protocol;
@@ -2554,22 +2607,20 @@ struct bpf_fib_lookup { 
		__u8	tos;		/* AF_INET  */

		__be32	flowlabel;	/* AF_INET6 */



		/* output: metric of fib result */

		/* output: metric of fib result (IPv4/IPv6 only) */

		__u32	rt_metric;

	};



	union {

		__be32		mpls_in;

		__be32		ipv4_src;

		__u32		ipv6_src[4];  /* in6_addr; network order */

	};



	/* input to bpf_fib_lookup, *dst is destination address.

	 * output: bpf_fib_lookup sets to gateway address

	/* input to bpf_fib_lookup, ipv{4,6}_dst is destination address in

	 * network header. output: bpf_fib_lookup sets to gateway address

	 * if FIB lookup returns gateway route

	 */

	union {

		/* return for MPLS lookups */

		__be32		mpls_out[4];  /* support up to 4 labels */

		__be32		ipv4_dst;

		__u32		ipv6_dst[4];  /* in6_addr; network order */

	};

tools/include/uapi/linux/lirc.h

0 → 100644
+217 −0
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */

/*

 * lirc.h - linux infrared remote control header file

 * last modified 2010/07/13 by Jarod Wilson

 */



#ifndef _LINUX_LIRC_H

#define _LINUX_LIRC_H



#include <linux/types.h>

#include <linux/ioctl.h>



#define PULSE_BIT       0x01000000

#define PULSE_MASK      0x00FFFFFF



#define LIRC_MODE2_SPACE     0x00000000

#define LIRC_MODE2_PULSE     0x01000000

#define LIRC_MODE2_FREQUENCY 0x02000000

#define LIRC_MODE2_TIMEOUT   0x03000000



#define LIRC_VALUE_MASK      0x00FFFFFF

#define LIRC_MODE2_MASK      0xFF000000



#define LIRC_SPACE(val) (((val)&LIRC_VALUE_MASK) | LIRC_MODE2_SPACE)

#define LIRC_PULSE(val) (((val)&LIRC_VALUE_MASK) | LIRC_MODE2_PULSE)

#define LIRC_FREQUENCY(val) (((val)&LIRC_VALUE_MASK) | LIRC_MODE2_FREQUENCY)

#define LIRC_TIMEOUT(val) (((val)&LIRC_VALUE_MASK) | LIRC_MODE2_TIMEOUT)



#define LIRC_VALUE(val) ((val)&LIRC_VALUE_MASK)

#define LIRC_MODE2(val) ((val)&LIRC_MODE2_MASK)



#define LIRC_IS_SPACE(val) (LIRC_MODE2(val) == LIRC_MODE2_SPACE)

#define LIRC_IS_PULSE(val) (LIRC_MODE2(val) == LIRC_MODE2_PULSE)

#define LIRC_IS_FREQUENCY(val) (LIRC_MODE2(val) == LIRC_MODE2_FREQUENCY)

#define LIRC_IS_TIMEOUT(val) (LIRC_MODE2(val) == LIRC_MODE2_TIMEOUT)



/* used heavily by lirc userspace */

#define lirc_t int



/*** lirc compatible hardware features ***/



#define LIRC_MODE2SEND(x) (x)

#define LIRC_SEND2MODE(x) (x)

#define LIRC_MODE2REC(x) ((x) << 16)

#define LIRC_REC2MODE(x) ((x) >> 16)



#define LIRC_MODE_RAW                  0x00000001

#define LIRC_MODE_PULSE                0x00000002

#define LIRC_MODE_MODE2                0x00000004

#define LIRC_MODE_SCANCODE             0x00000008

#define LIRC_MODE_LIRCCODE             0x00000010





#define LIRC_CAN_SEND_RAW              LIRC_MODE2SEND(LIRC_MODE_RAW)

#define LIRC_CAN_SEND_PULSE            LIRC_MODE2SEND(LIRC_MODE_PULSE)

#define LIRC_CAN_SEND_MODE2            LIRC_MODE2SEND(LIRC_MODE_MODE2)

#define LIRC_CAN_SEND_LIRCCODE         LIRC_MODE2SEND(LIRC_MODE_LIRCCODE)



#define LIRC_CAN_SEND_MASK             0x0000003f



#define LIRC_CAN_SET_SEND_CARRIER      0x00000100

#define LIRC_CAN_SET_SEND_DUTY_CYCLE   0x00000200

#define LIRC_CAN_SET_TRANSMITTER_MASK  0x00000400



#define LIRC_CAN_REC_RAW               LIRC_MODE2REC(LIRC_MODE_RAW)

#define LIRC_CAN_REC_PULSE             LIRC_MODE2REC(LIRC_MODE_PULSE)

#define LIRC_CAN_REC_MODE2             LIRC_MODE2REC(LIRC_MODE_MODE2)

#define LIRC_CAN_REC_SCANCODE          LIRC_MODE2REC(LIRC_MODE_SCANCODE)

#define LIRC_CAN_REC_LIRCCODE          LIRC_MODE2REC(LIRC_MODE_LIRCCODE)



#define LIRC_CAN_REC_MASK              LIRC_MODE2REC(LIRC_CAN_SEND_MASK)



#define LIRC_CAN_SET_REC_CARRIER       (LIRC_CAN_SET_SEND_CARRIER << 16)

#define LIRC_CAN_SET_REC_DUTY_CYCLE    (LIRC_CAN_SET_SEND_DUTY_CYCLE << 16)



#define LIRC_CAN_SET_REC_DUTY_CYCLE_RANGE 0x40000000

#define LIRC_CAN_SET_REC_CARRIER_RANGE    0x80000000

#define LIRC_CAN_GET_REC_RESOLUTION       0x20000000

#define LIRC_CAN_SET_REC_TIMEOUT          0x10000000

#define LIRC_CAN_SET_REC_FILTER           0x08000000



#define LIRC_CAN_MEASURE_CARRIER          0x02000000

#define LIRC_CAN_USE_WIDEBAND_RECEIVER    0x04000000



#define LIRC_CAN_SEND(x) ((x)&LIRC_CAN_SEND_MASK)

#define LIRC_CAN_REC(x) ((x)&LIRC_CAN_REC_MASK)



#define LIRC_CAN_NOTIFY_DECODE            0x01000000



/*** IOCTL commands for lirc driver ***/



#define LIRC_GET_FEATURES              _IOR('i', 0x00000000, __u32)



#define LIRC_GET_SEND_MODE             _IOR('i', 0x00000001, __u32)

#define LIRC_GET_REC_MODE              _IOR('i', 0x00000002, __u32)

#define LIRC_GET_REC_RESOLUTION        _IOR('i', 0x00000007, __u32)



#define LIRC_GET_MIN_TIMEOUT           _IOR('i', 0x00000008, __u32)

#define LIRC_GET_MAX_TIMEOUT           _IOR('i', 0x00000009, __u32)



/* code length in bits, currently only for LIRC_MODE_LIRCCODE */

#define LIRC_GET_LENGTH                _IOR('i', 0x0000000f, __u32)



#define LIRC_SET_SEND_MODE             _IOW('i', 0x00000011, __u32)

#define LIRC_SET_REC_MODE              _IOW('i', 0x00000012, __u32)

/* Note: these can reset the according pulse_width */

#define LIRC_SET_SEND_CARRIER          _IOW('i', 0x00000013, __u32)

#define LIRC_SET_REC_CARRIER           _IOW('i', 0x00000014, __u32)

#define LIRC_SET_SEND_DUTY_CYCLE       _IOW('i', 0x00000015, __u32)

#define LIRC_SET_TRANSMITTER_MASK      _IOW('i', 0x00000017, __u32)



/*

 * when a timeout != 0 is set the driver will send a

 * LIRC_MODE2_TIMEOUT data packet, otherwise LIRC_MODE2_TIMEOUT is

 * never sent, timeout is disabled by default

 */

#define LIRC_SET_REC_TIMEOUT           _IOW('i', 0x00000018, __u32)



/* 1 enables, 0 disables timeout reports in MODE2 */

#define LIRC_SET_REC_TIMEOUT_REPORTS   _IOW('i', 0x00000019, __u32)



/*

 * if enabled from the next key press on the driver will send

 * LIRC_MODE2_FREQUENCY packets

 */

#define LIRC_SET_MEASURE_CARRIER_MODE	_IOW('i', 0x0000001d, __u32)



/*

 * to set a range use LIRC_SET_REC_CARRIER_RANGE with the

 * lower bound first and later LIRC_SET_REC_CARRIER with the upper bound

 */

#define LIRC_SET_REC_CARRIER_RANGE     _IOW('i', 0x0000001f, __u32)



#define LIRC_SET_WIDEBAND_RECEIVER     _IOW('i', 0x00000023, __u32)



/*

 * struct lirc_scancode - decoded scancode with protocol for use with

 *	LIRC_MODE_SCANCODE

 *

 * @timestamp: Timestamp in nanoseconds using CLOCK_MONOTONIC when IR

 *	was decoded.

 * @flags: should be 0 for transmit. When receiving scancodes,

 *	LIRC_SCANCODE_FLAG_TOGGLE or LIRC_SCANCODE_FLAG_REPEAT can be set

 *	depending on the protocol

 * @rc_proto: see enum rc_proto

 * @keycode: the translated keycode. Set to 0 for transmit.

 * @scancode: the scancode received or to be sent

 */

struct lirc_scancode {

	__u64	timestamp;

	__u16	flags;

	__u16	rc_proto;

	__u32	keycode;

	__u64	scancode;

};



/* Set if the toggle bit of rc-5 or rc-6 is enabled */

#define LIRC_SCANCODE_FLAG_TOGGLE	1

/* Set if this is a nec or sanyo repeat */

#define LIRC_SCANCODE_FLAG_REPEAT	2



/**

 * enum rc_proto - the Remote Controller protocol

 *

 * @RC_PROTO_UNKNOWN: Protocol not known

 * @RC_PROTO_OTHER: Protocol known but proprietary

 * @RC_PROTO_RC5: Philips RC5 protocol

 * @RC_PROTO_RC5X_20: Philips RC5x 20 bit protocol

 * @RC_PROTO_RC5_SZ: StreamZap variant of RC5

 * @RC_PROTO_JVC: JVC protocol

 * @RC_PROTO_SONY12: Sony 12 bit protocol

 * @RC_PROTO_SONY15: Sony 15 bit protocol

 * @RC_PROTO_SONY20: Sony 20 bit protocol

 * @RC_PROTO_NEC: NEC protocol

 * @RC_PROTO_NECX: Extended NEC protocol

 * @RC_PROTO_NEC32: NEC 32 bit protocol

 * @RC_PROTO_SANYO: Sanyo protocol

 * @RC_PROTO_MCIR2_KBD: RC6-ish MCE keyboard

 * @RC_PROTO_MCIR2_MSE: RC6-ish MCE mouse

 * @RC_PROTO_RC6_0: Philips RC6-0-16 protocol

 * @RC_PROTO_RC6_6A_20: Philips RC6-6A-20 protocol

 * @RC_PROTO_RC6_6A_24: Philips RC6-6A-24 protocol

 * @RC_PROTO_RC6_6A_32: Philips RC6-6A-32 protocol

 * @RC_PROTO_RC6_MCE: MCE (Philips RC6-6A-32 subtype) protocol

 * @RC_PROTO_SHARP: Sharp protocol

 * @RC_PROTO_XMP: XMP protocol

 * @RC_PROTO_CEC: CEC protocol

 * @RC_PROTO_IMON: iMon Pad protocol

 */

enum rc_proto {

	RC_PROTO_UNKNOWN	= 0,

	RC_PROTO_OTHER		= 1,

	RC_PROTO_RC5		= 2,

	RC_PROTO_RC5X_20	= 3,

	RC_PROTO_RC5_SZ		= 4,

	RC_PROTO_JVC		= 5,

	RC_PROTO_SONY12		= 6,

	RC_PROTO_SONY15		= 7,

	RC_PROTO_SONY20		= 8,

	RC_PROTO_NEC		= 9,

	RC_PROTO_NECX		= 10,

	RC_PROTO_NEC32		= 11,

	RC_PROTO_SANYO		= 12,

	RC_PROTO_MCIR2_KBD	= 13,

	RC_PROTO_MCIR2_MSE	= 14,

	RC_PROTO_RC6_0		= 15,

	RC_PROTO_RC6_6A_20	= 16,

	RC_PROTO_RC6_6A_24	= 17,

	RC_PROTO_RC6_6A_32	= 18,

	RC_PROTO_RC6_MCE	= 19,

	RC_PROTO_SHARP		= 20,

	RC_PROTO_XMP		= 21,

	RC_PROTO_CEC		= 22,

	RC_PROTO_IMON		= 23,

};



#endif

tools/lib/bpf/libbpf.c

+1 −0
Original line number Diff line number Diff line
@@ -1462,6 +1462,7 @@ static bool bpf_prog_type__needs_kver(enum bpf_prog_type type) 
	case BPF_PROG_TYPE_CGROUP_DEVICE:

	case BPF_PROG_TYPE_SK_MSG:

	case BPF_PROG_TYPE_CGROUP_SOCK_ADDR:

	case BPF_PROG_TYPE_LIRC_MODE2:

		return false;

	case BPF_PROG_TYPE_UNSPEC:

	case BPF_PROG_TYPE_KPROBE:

tools/testing/selftests/bpf/.gitignore

+1 −0
Original line number Diff line number Diff line
@@ -17,3 +17,4 @@ test_sock_addr 
urandom_read

test_btf

test_sockmap

test_lirc_mode2_user