staging: gpib: Clean up uapi include files
cover staging: gpib: Clean up uapi include files
This patch set addresses a number of issues identified in the uapi include files.
Patch 1 - Remove enums and functions that are not needed to be
exported to user space.
Patch 2 - Add removed enums and functions dealing with GPIB
command bytes needed only by the kernel drivers in a new local include file gpib_cmd.h
Patch 3 - Convert generic types to fixed size types in the
gpib_ioctl.h include file.
Patch 4 - Pad bit and byte holes in the ioctl structs.
Dave Penkler (4):
staging: gpib: Remove unneeded enums and functions
staging: gpib: Add local include file for commands
staging: gpib: Use standard size basic uapi types
staging: gpib: Add bit and byte padding to ioctl structs
drivers/staging/gpib/include/gpibP.h | 1 + drivers/staging/gpib/include/gpib_cmd.h | 112 ++++++++++++++ drivers/staging/gpib/uapi/gpib.h | 198 ------------------------ drivers/staging/gpib/uapi/gpib_ioctl.h | 112 +++++++------- 4 files changed, 171 insertions(+), 252 deletions(-) create mode 100644 drivers/staging/gpib/include/gpib_cmd.h
Signature · 1 line
2.49.0
PATCH 1/4 staging: gpib: Remove unneeded enums and functions
Remove enums and functions that do not need to be shared with user space.
Remove enums and functions that are not needed in the kernel drivers.
--- drivers/staging/gpib/uapi/gpib.h | 198 ------------------------------- 1 file changed, 198 deletions(-)
drivers/staging/gpib/uapi/gpib.h +0 -198
@@ -83,204 +83,12 @@ enum bus_control_line { BUS_EOI = 0x8000 /* EOI line status bit */ }; -/* Possible GPIB command messages */ - -enum cmd_byte { -GTL =0x1 ,/* go to local */ -SDC =0x4 ,/* selected device clear */ -PP_CONFIG =0x5 , -#ifndef PPC -PPC =PP_CONFIG ,/* parallel poll configure */ -#endif -GET =0x8 ,/* group execute trigger */ -TCT =0x9 ,/* take control */ -LLO =0x11 ,/* local lockout */ -DCL =0x14 ,/* device clear */ -PPU =0x15 ,/* parallel poll unconfigure */ -SPE =0x18 ,/* serial poll enable */ -SPD =0x19 ,/* serial poll disable */ -CFE =0x1f ,/* configure enable */ -LAD =0x20 ,/* value to be 'ored' in to obtain listen address */ -UNL =0x3F ,/* unlisten */ -TAD =0x40 ,/* value to be 'ored' in to obtain talk address */ -UNT =0x5F ,/* untalk */ -SAD =0x60 ,/* my secondary address (base) */ -PPE =0x60 ,/* parallel poll enable (base) */ -PPD =0x70 /* parallel poll disable */ -}; -enum ppe_bits {PPC_DISABLE =0x10 ,PPC_SENSE =0x8 ,/* parallel poll sense bit */ PPC_DIO_MASK =0x7 }; -/* confine address to range 0 to 30. */ -static inline unsigned int gpib_address_restrict (unsigned int addr) -{ - addr &=0x1f ; -if (addr ==0x1f ) - addr =0 ; -return addr; -} - -static inline __u8 MLA (unsigned int addr) -{ -return gpib_address_restrict (addr) |LAD ; -} - -static inline __u8 MTA (unsigned int addr) -{ -return gpib_address_restrict (addr) |TAD ; -} - -static inline __u8 MSA (unsigned int addr) -{ -return (addr &0x1f ) |SAD ; -} - -static inline __u8 PPE_byte (unsigned int dio_line,int sense) -{ -__u8 cmd; - - cmd =PPE ; -if (sense) - cmd |=PPC_SENSE ; - cmd |= (dio_line -1 ) &0x7 ; -return cmd; -} - -/* mask of bits that actually matter in a command byte */ -enum { - gpib_command_mask =0x7f , -}; - -static inline int is_PPE (__u8 command) -{ -return (command &0x70 ) ==0x60 ; -} - -static inline int is_PPD (__u8 command) -{ -return (command &0x70 ) ==0x70 ; -} - -static inline int in_addressed_command_group (__u8 command) -{ -return (command &0x70 ) ==0x0 ; -} - -static inline int in_universal_command_group (__u8 command) -{ -return (command &0x70 ) ==0x10 ; -} - -static inline int in_listen_address_group (__u8 command) -{ -return (command &0x60 ) ==0x20 ; -} - -static inline int in_talk_address_group (__u8 command) -{ -return (command &0x60 ) ==0x40 ; -} - -static inline int in_primary_command_group (__u8 command) -{ -return in_addressed_command_group (command) || -in_universal_command_group (command) || -in_listen_address_group (command) || -in_talk_address_group (command); -} - -static inline int gpib_address_equal (unsigned int pad1,int sad1,unsigned int pad2,int sad2) -{ -if (pad1 == pad2) { -if (sad1 == sad2) -return 1 ; -if (sad1 <0 && sad2 <0 ) -return 1 ; - } - -return 0 ; -} - -enum ibask_option { -IBA_PAD =0x1 , -IBA_SAD =0x2 , -IBA_TMO =0x3 , -IBA_EOT =0x4 , -IBA_PPC =0x5 ,/* board only */ -IBA_READ_DR =0x6 ,/* device only */ -IBA_AUTOPOLL =0x7 ,/* board only */ -IBA_CICPROT =0x8 ,/* board only */ -IBA_IRQ =0x9 ,/* board only */ -IBA_SC =0xa ,/* board only */ -IBA_SRE =0xb ,/* board only */ -IBA_EOS_RD =0xc , -IBA_EOS_WRT =0xd , -IBA_EOS_CMP =0xe , -IBA_EOS_CHAR =0xf , -IBA_PP2 =0x10 ,/* board only */ -IBA_TIMING =0x11 ,/* board only */ -IBA_DMA =0x12 ,/* board only */ -IBA_READ_ADJUST =0x13 , -IBA_WRITE_ADJUST =0x14 , -IBA_EVENT_QUEUE =0x15 ,/* board only */ -IBA_SPOLL_BIT =0x16 ,/* board only */ -IBA_SEND_LLO =0x17 ,/* board only */ -IBA_SPOLL_TIME =0x18 ,/* device only */ -IBA_PPOLL_TIME =0x19 ,/* board only */ -IBA_END_BIT_IS_NORMAL =0x1a , -IBA_UN_ADDR =0x1b ,/* device only */ -IBA_HS_CABLE_LENGTH =0x1f ,/* board only */ -IBA_IST =0x20 ,/* board only */ -IBA_RSV =0x21 ,/* board only */ -IBA_BNA =0x200 ,/* device only */ -/* linux-gpib extensions */ -IBA_7_BIT_EOS =0x1000 /* board only. Returns 1 if board supports 7 bit eos compares*/ -}; - -enum ibconfig_option { -IBC_PAD =0x1 , -IBC_SAD =0x2 , -IBC_TMO =0x3 , -IBC_EOT =0x4 , -IBC_PPC =0x5 ,/* board only */ -IBC_READDR =0x6 ,/* device only */ -IBC_AUTOPOLL =0x7 ,/* board only */ -IBC_CICPROT =0x8 ,/* board only */ -IBC_IRQ =0x9 ,/* board only */ -IBC_SC =0xa ,/* board only */ -IBC_SRE =0xb ,/* board only */ -IBC_EOS_RD =0xc , -IBC_EOS_WRT =0xd , -IBC_EOS_CMP =0xe , -IBC_EOS_CHAR =0xf , -IBC_PP2 =0x10 ,/* board only */ -IBC_TIMING =0x11 ,/* board only */ -IBC_DMA =0x12 ,/* board only */ -IBC_READ_ADJUST =0x13 , -IBC_WRITE_ADJUST =0x14 , -IBC_EVENT_QUEUE =0x15 ,/* board only */ -IBC_SPOLL_BIT =0x16 ,/* board only */ -IBC_SEND_LLO =0x17 ,/* board only */ -IBC_SPOLL_TIME =0x18 ,/* device only */ -IBC_PPOLL_TIME =0x19 ,/* board only */ -IBC_END_BIT_IS_NORMAL =0x1a , -IBC_UN_ADDR =0x1b ,/* device only */ -IBC_HS_CABLE_LENGTH =0x1f ,/* board only */ -IBC_IST =0x20 ,/* board only */ -IBC_RSV =0x21 ,/* board only */ -IBC_BNA =0x200 /* device only */ -}; - -enum t1_delays { - T1_DELAY_2000ns =1 , - T1_DELAY_500ns =2 , - T1_DELAY_350ns =3 -}; -enum { request_service_bit =0x40 , };
@@ -292,11 +100,5 @@ enum gpib_events {EVENT_IFC =3 }; -enum gpib_stb { -IB_STB_RQS =0x40 ,/* IEEE 488.1 & 2 */ -IB_STB_ESB =0x20 ,/* IEEE 488.2 only */ -IB_STB_MAV =0x10 /* IEEE 488.2 only */ -}; -#endif /* _GPIB_H */
Signature · 1 line
2.49.0
PATCH 2/4 staging: gpib: Add local include file for commands
In reply to Dave PenklerAdd the functions and enums needed only by the kernel drivers that were removed from the uapi/gpib.h include file to a separate local include file.
Include this new file in the gpibP.h local include file.
--- drivers/staging/gpib/include/gpibP.h | 1 + drivers/staging/gpib/include/gpib_cmd.h | 112 ++++++++++++++++++++++++ 2 files changed, 113 insertions(+) create mode 100644 drivers/staging/gpib/include/gpib_cmd.h
drivers/staging/gpib/include/gpibP.h +1 -0
@@ -11,6 +11,7 @@#include "gpib_types.h" #include "gpib_proto.h" +#include "gpib_cmd.h" #include "gpib.h" #include "gpib_ioctl.h"
drivers/staging/gpib/include/gpib_cmd.h new file +112 -0
112 lines not on this page · raw message
Signature · 1 line
2.49.0
PATCH 3/4 staging: gpib: Use standard size basic uapi types
In reply to Dave PenklerChange unsigned int to __u32,
int to __s32
and short to __s16
--- drivers/staging/gpib/uapi/gpib_ioctl.h | 106 ++++++++++++------------- 1 file changed, 53 insertions(+), 53 deletions(-)
drivers/staging/gpib/uapi/gpib_ioctl.h +53 -53
@@ -19,71 +19,71 @@ struct gpib_board_type_ioctl {/* argument for read/write/command ioctls */ struct gpib_read_write_ioctl {__u64 buffer_ptr; -unsigned int requested_transfer_count; -unsigned int completed_transfer_count; -int end;/* end flag return for reads, end io suppression request for cmd*/ -int handle; +__u32 requested_transfer_count; +__u32 completed_transfer_count; +__s32 end;/* end flag return for reads, end io suppression request for cmd*/ +__s32 handle; };struct gpib_open_dev_ioctl { -unsigned int handle; -unsigned int pad; -int sad; +__u32 handle; +__u32 pad; +__s32 sad;unsigned is_board :1 ; };struct gpib_close_dev_ioctl { -unsigned int handle; +__u32 handle; };struct gpib_serial_poll_ioctl { -unsigned int pad; -int sad; +__u32 pad; +__s32 sad;__u8 status_byte; };struct gpib_eos_ioctl { -int eos; -int eos_flags; +__s32 eos; +__s32 eos_flags; };struct gpib_wait_ioctl { -int handle; -int wait_mask; -int clear_mask; -int set_mask; -int ibsta; -int pad; -int sad; -unsigned int usec_timeout; +__s32 handle; +__s32 wait_mask; +__s32 clear_mask; +__s32 set_mask; +__s32 ibsta; +__s32 pad; +__s32 sad; +__u32 usec_timeout; };struct gpib_online_ioctl {__u64 init_data_ptr; -int init_data_length; -int online; +__s32 init_data_length; +__s32 online; };struct gpib_spoll_bytes_ioctl { -unsigned int num_bytes; -unsigned int pad; -int sad; +__u32 num_bytes; +__u32 pad; +__s32 sad; };struct gpib_board_info_ioctl { -unsigned int pad; -int sad; -int parallel_poll_configuration; -int autopolling; -int is_system_controller; -unsigned int t1_delay; +__u32 pad; +__s32 sad; +__s32 parallel_poll_configuration; +__s32 autopolling; +__s32 is_system_controller; +__u32 t1_delay;unsigned ist :1 ;unsigned no_7_bit_eos :1 ; };struct gpib_select_pci_ioctl { -int pci_bus; -int pci_slot; +__s32 pci_bus; +__s32 pci_slot; };struct gpib_ppoll_config_ioctl {
@@ -93,13 +93,13 @@ struct gpib_ppoll_config_ioctl { };struct gpib_pad_ioctl { -unsigned int handle; -unsigned int pad; +__u32 handle; +__u32 pad; };struct gpib_sad_ioctl { -unsigned int handle; -int sad; +__u32 handle; +__s32 sad; };// select a piece of hardware to attach by its sysfs device path
@@ -110,7 +110,7 @@ struct gpib_select_device_path_ioctl {// update status byte and request service struct gpib_request_service2 {__u8 status_byte; -int new_reason_for_service; +__s32 new_reason_for_service; };/* Standard functions. */
@@ -123,38 +123,38 @@ enum gpib_ioctl { IBWAIT = _IOWR(GPIB_CODE, 5, struct gpib_wait_ioctl),IBRPP =_IOWR (GPIB_CODE ,6 , __u8), - IBSIC = _IOW(GPIB_CODE, 9, unsigned int), -IBSRE =_IOW (GPIB_CODE ,10 , int), +IBSIC =_IOW (GPIB_CODE ,9 , __u32), +IBSRE =_IOW (GPIB_CODE ,10 , __s32),IBGTS =_IO (GPIB_CODE ,11 ), -IBCAC =_IOW (GPIB_CODE ,12 , int), -IBLINES =_IOR (GPIB_CODE ,14 , short), +IBCAC =_IOW (GPIB_CODE ,12 , __s32), +IBLINES =_IOR (GPIB_CODE ,14 , __s16), IBPAD = _IOW(GPIB_CODE, 15, struct gpib_pad_ioctl), IBSAD = _IOW(GPIB_CODE, 16, struct gpib_sad_ioctl), - IBTMO = _IOW(GPIB_CODE, 17, unsigned int), +IBTMO =_IOW (GPIB_CODE ,17 , __u32), IBRSP = _IOWR(GPIB_CODE, 18, struct gpib_serial_poll_ioctl), IBEOS = _IOW(GPIB_CODE, 19, struct gpib_eos_ioctl),IBRSV =_IOW (GPIB_CODE ,20 , __u8),CFCBASE =_IOW (GPIB_CODE ,21 , __u64), - CFCIRQ = _IOW(GPIB_CODE, 22, unsigned int), - CFCDMA = _IOW(GPIB_CODE, 23, unsigned int), +CFCIRQ =_IOW (GPIB_CODE ,22 , __u32), +CFCDMA =_IOW (GPIB_CODE ,23 , __u32), CFCBOARDTYPE = _IOW(GPIB_CODE, 24, struct gpib_board_type_ioctl), -IBMUTEX =_IOW (GPIB_CODE ,26 , int), +IBMUTEX =_IOW (GPIB_CODE ,26 , __s32), IBSPOLL_BYTES = _IOWR(GPIB_CODE, 27, struct gpib_spoll_bytes_ioctl), IBPPC = _IOW(GPIB_CODE, 28, struct gpib_ppoll_config_ioctl), IBBOARD_INFO = _IOR(GPIB_CODE, 29, struct gpib_board_info_ioctl), -IBQUERY_BOARD_RSV =_IOR (GPIB_CODE ,31 , int), +IBQUERY_BOARD_RSV =_IOR (GPIB_CODE ,31 , __s32), IBSELECT_PCI = _IOWR(GPIB_CODE, 32, struct gpib_select_pci_ioctl), -IBEVENT =_IOR (GPIB_CODE ,33 , short), -IBRSC =_IOW (GPIB_CODE ,34 , int), - IB_T1_DELAY = _IOW(GPIB_CODE, 35, unsigned int), +IBEVENT =_IOR (GPIB_CODE ,33 , __s16), +IBRSC =_IOW (GPIB_CODE ,34 , __s32), +IB_T1_DELAY =_IOW (GPIB_CODE ,35 , __u32),IBLOC =_IO (GPIB_CODE ,36 ), -IBAUTOSPOLL =_IOW (GPIB_CODE ,38 , short), +IBAUTOSPOLL =_IOW (GPIB_CODE ,38 , __s16), IBONL = _IOW(GPIB_CODE, 39, struct gpib_online_ioctl), -IBPP2_SET =_IOW (GPIB_CODE ,40 , short), -IBPP2_GET =_IOR (GPIB_CODE ,41 , short), +IBPP2_SET =_IOW (GPIB_CODE ,40 , __s16), +IBPP2_GET =_IOR (GPIB_CODE ,41 , __s16), IBSELECT_DEVICE_PATH = _IOW(GPIB_CODE, 43, struct gpib_select_device_path_ioctl),// 44 was IBSELECT_SERIAL_NUMBER IBRSV2 = _IOW(GPIB_CODE, 45, struct gpib_request_service2)
Signature · 1 line
2.49.0
PATCH 4/4 staging: gpib: Add bit and byte padding to ioctl structs
In reply to Dave PenklerEnsure that all structs have a size that is an integral mutliple of 32 bits.
Change trailing single bit field to __u32 in gpib_open_dev_ioctl Add byte padding to gpib_serial_poll_ioctl and gpib_request_service2 Add bit padding to gpib_board_info_ioctl and gpib_ppoll_config_ioctl
--- drivers/staging/gpib/uapi/gpib_ioctl.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
drivers/staging/gpib/uapi/gpib_ioctl.h +5 -1
@@ -29,7 +29,7 @@ struct gpib_open_dev_ioctl {__u32 handle;__u32 pad;__s32 sad; - unsigned is_board : 1; +__u32 is_board; };struct gpib_close_dev_ioctl {
@@ -40,6 +40,7 @@ struct gpib_serial_poll_ioctl {__u32 pad;__s32 sad;__u8 status_byte; +__u8 padding[3 ];// align to 32 bit boundary };struct gpib_eos_ioctl {
@@ -79,6 +80,7 @@ struct gpib_board_info_ioctl {__u32 t1_delay; unsigned ist : 1; unsigned no_7_bit_eos : 1; + unsigned padding :30; // align to 32 bit boundary };struct gpib_select_pci_ioctl {
@@ -90,6 +92,7 @@ struct gpib_ppoll_config_ioctl {__u8 config; unsigned set_ist : 1; unsigned clear_ist : 1; + unsigned padding :22; // align to 32 bit boundary };struct gpib_pad_ioctl {
@@ -110,6 +113,7 @@ struct gpib_select_device_path_ioctl {// update status byte and request service struct gpib_request_service2 {__u8 status_byte; +__u8 padding[3 ];// align to 32 bit boundary __s32 new_reason_for_service; };
Signature · 1 line
2.49.0