Topcliff PHUB: Generate PacketHub driver
Hi Arnd,
Sorry, for late patch releasing.
I have modified like below.
We will release today.
Quoted 12 lines · Masayuki Ohtak
Review
Quoted 5 lines
(quoted diff) +5
-0+ +#define PCH_READ_REG(a) ioread32(pch_phub_reg.pch_phub_base_address + (a)) + +#define PCH_WRITE_REG(a, b) iowrite32((a), pch_phub_reg.pch_phub_base_address +\ + (b))I'd recommend just getting rid of these abstractions. You only use them in one or two functions each, so you can just as well add a local variable there and do
Quoted 7 lines
void
__iomem*p = pch_phub_reg.pch_phub_base_address; foo =ioread32(p + foo_offset);
bar =ioread32(p + bar_offset);
...Not really important, but this way it would be more conventional without having to write extra code.
Modified like above.
Quoted 20 lines
Quoted 20 lines
(quoted diff) +19
-0+/*-------------------------------------------- + global variables +--------------------------------------------*/ +/** + * struct pch_phub_reg_t - PHUB register structure + * @phub_id_reg: PHUB_ID register val + * @q_pri_val_reg: QUEUE_PRI_VAL register val + * @rc_q_maxsize_reg: RC_QUEUE_MAXSIZE register val + * @bri_q_maxsize_reg: BRI_QUEUE_MAXSIZE register val + * @comp_resp_timeout_reg: COMP_RESP_TIMEOUT register val + * @bus_slave_control_reg: BUS_SLAVE_CONTROL_REG register val + * @deadlock_avoid_type_reg: DEADLOCK_AVOID_TYPE register val + * @intpin_reg_wpermit_reg0: INTPIN_REG_WPERMIT register 0 val + * @intpin_reg_wpermit_reg1: INTPIN_REG_WPERMIT register 1 val + * @intpin_reg_wpermit_reg2: INTPIN_REG_WPERMIT register 2 val + * @intpin_reg_wpermit_reg3: INTPIN_REG_WPERMIT register 3 val + * @int_reduce_control_reg: INT_REDUCE_CONTROL registers val + * @clkcfg_reg: CLK CFG register val + * @pch_phub_base_address: register base address
Quoted 8 lines
Quoted 4 lines
+ * @pch_phub_extrom_base_address: external rom base address
+ * @pch_phub_suspended: PHUB status val
+ */
+structpch_phub_reg_t{It would be better to drop the _t postfix on the type name. By convention, we use this only for typedefs on simple data types like
off_tbut not for structures.
Deleted '_t' prefix
Quoted 9 lines
Quoted 4 lines
+
__u32phub_id_reg;
+__u32q_pri_val_reg;
+__u32rc_q_maxsize_reg;When I told you to change the ioctl arguments to use
__u32instead of u32, I was only referring to those parts that are in the user-visible section of the header file. While it does not hurt to use__u32in the kernel, you should understand the distinction.
The following types are modified like below except user-visible secton '__u8 mac_addr[6]. __u32 -> unsigned int__s32 -> int__u8 -> unsigned char__s8 -> char
Quoted 14 lines
Review
Quoted 12 lines
(quoted diff) +11
-0+/** pch_phub_write - Implements the write functionality of the Packet Hub + * module. + * @file: Contains the reference of the file structure + * @buf: Usermode buffer pointer + * @size: Usermode buffer size + * @ppos: Contains the reference of the file structure + */ +static ssize_t pch_phub_write(struct file *file, const char __user *buf, + size_t size, loff_t *ppos) +{ + static __u32 data;No need to make data static.
Deleted 'static'.
Quoted 11 lines
Quoted 11 lines
+
__s32ret_value;
+__u32addr_offset= 0;
+loff_tpos = *ppos;(quoted diff) +7
-0+ + if (pos < 0) + return -EINVAL; + + for (addr_offset = 0; addr_offset < size; addr_offset++) { + get_user(data, &buf[addr_offset]); +
Quoted 8 lines
Quoted 4 lines
+
ret_value= pch_phub_write_serial_rom(0x80 +addr_offset+ pos,
+ data);
+ if (ret_value)
+ return-EFAULT;You should return
-EFAULTif theget_user()call fails, otherwise you have a possible security hole. Ifpch_phub_write_serial_romfails, the correct return code would be-EIO.
Modified to care returned value of get_user. Modified retunrn code of pch_phub_write_serial_rom to -EIO.
Quoted 16 lines
Review
Quoted 10 lines
(quoted diff) +9
-0+/** + * file_operations structure initialization + */ +static const struct file_operations pch_phub_fops = { + .owner = THIS_MODULE, + .read = pch_phub_read, + .write = pch_phub_write, + .unlocked_ioctl = pch_phub_ioctl, +};If would be good to add a line of
.llseek =default_llseek,
here. I have a patch to change the default llseek method to one that disallows seeking, so if you add this line, there is one less driver for me to patch.
Added a line of '.llseek = default_llseek'.
Thanks,
Ohtake
----- Original Message -----
From: "Masayuki Ohtake" <[email protected]>
To: "Arnd Bergmann" <[email protected]>
Cc: "Wang, Yong Y" <[email protected]>; "Wang, Qi" <[email protected]>; "Intel OTC" <[email protected]>; "Andrew" <[email protected]>; "LKML" <[email protected]>; "Alan Cox" <[email protected]>
Sent: Friday, June 18, 2010 8:49 AM
Subject: Re: [PATCH] Topcliff PHUB: Generate PacketHub driver
Quoted 130 lines
Hi Arnd,
I will modify for your comments by today or tomorrow.
Thanks,
Ohtake----- Original Message -----
From: "Arnd Bergmann" <[email protected]>
To: "Masayuki Ohtak" <[email protected]>
Cc: "Alan Cox" <[email protected]>; "LKML" <[email protected]>; "Andrew" <[email protected]>; "Intel OTC" <[email protected]>; "Wang, Qi" <[email protected]>; "Wang, Yong Y" <[email protected]>
Sent: Thursday, June 17, 2010 8:59 PM
Subject: Re: [PATCH] Topcliff PHUB: Generate PacketHub driverQuoted 110 lines
Looks almost good to me now. Some more details (only the
-EFAULTreturn code is a real issue, the other ones are cosmetic changes):Review
Quoted 5 lines · Masayuki Ohtak
(quoted diff) +5
-0+ +#define PCH_READ_REG(a) ioread32(pch_phub_reg.pch_phub_base_address + (a)) + +#define PCH_WRITE_REG(a, b) iowrite32((a), pch_phub_reg.pch_phub_base_address +\ + (b))I'd recommend just getting rid of these abstractions. You only use them in one or two functions each, so you can just as well add a local variable there and do
void
__iomem*p = pch_phub_reg.pch_phub_base_address; foo =ioread32(p + foo_offset);
bar =ioread32(p + bar_offset);
...Not really important, but this way it would be more conventional without having to write extra code.
Quoted 13 lines
(quoted diff) +13
-0+/*-------------------------------------------- + global variables +--------------------------------------------*/ +/** + * struct pch_phub_reg_t - PHUB register structure + * @phub_id_reg: PHUB_ID register val + * @q_pri_val_reg: QUEUE_PRI_VAL register val + * @rc_q_maxsize_reg: RC_QUEUE_MAXSIZE register val + * @bri_q_maxsize_reg: BRI_QUEUE_MAXSIZE register val + * @comp_resp_timeout_reg: COMP_RESP_TIMEOUT register val + * @bus_slave_control_reg: BUS_SLAVE_CONTROL_REG register val + * @deadlock_avoid_type_reg: DEADLOCK_AVOID_TYPE register val + * @intpin_reg_wpermit_reg0: INTPIN_REG_WPERMIT register 0 valReview
Quoted 10 lines
(quoted diff) +10
-0+ * @intpin_reg_wpermit_reg1: INTPIN_REG_WPERMIT register 1 val + * @intpin_reg_wpermit_reg2: INTPIN_REG_WPERMIT register 2 val + * @intpin_reg_wpermit_reg3: INTPIN_REG_WPERMIT register 3 val + * @int_reduce_control_reg: INT_REDUCE_CONTROL registers val + * @clkcfg_reg: CLK CFG register val + * @pch_phub_base_address: register base address + * @pch_phub_extrom_base_address: external rom base address + * @pch_phub_suspended: PHUB status val + */ +struct pch_phub_reg_t {It would be better to drop the _t postfix on the type name. By convention, we use this only for typedefs on simple data types like
off_tbut not for structures.Quoted 3 lines
+
__u32phub_id_reg;
+__u32q_pri_val_reg;
+__u32rc_q_maxsize_reg;When I told you to change the ioctl arguments to use
__u32instead of u32, I was only referring to those parts that are in the user-visible section of the header file. While it does not hurt to use__u32in the kernel, you should understand the distinction.Review
Quoted 11 lines
(quoted diff) +11
-0+/** pch_phub_write - Implements the write functionality of the Packet Hub + * module. + * @file: Contains the reference of the file structure + * @buf: Usermode buffer pointer + * @size: Usermode buffer size + * @ppos: Contains the reference of the file structure + */ +static ssize_t pch_phub_write(struct file *file, const char __user *buf, + size_t size, loff_t *ppos) +{ + static __u32 data;No need to make data static.
Quoted 4 lines
+
__s32ret_value;
+__u32addr_offset= 0;
+loff_tpos = *ppos;(quoted diff) +1
-0+Review
Quoted 10 lines
(quoted diff) +10
-0+ if (pos < 0) + return -EINVAL; + + for (addr_offset = 0; addr_offset < size; addr_offset++) { + get_user(data, &buf[addr_offset]); + + ret_value = pch_phub_write_serial_rom(0x80 + addr_offset + pos, + data); + if (ret_value) + return -EFAULT;You should return
-EFAULTif theget_user()call fails, otherwise you have a possible security hole. Ifpch_phub_write_serial_romfails, the correct return code would be-EIO.Review
Quoted 9 lines
(quoted diff) +9
-0+/** + * file_operations structure initialization + */ +static const struct file_operations pch_phub_fops = { + .owner = THIS_MODULE, + .read = pch_phub_read, + .write = pch_phub_write, + .unlocked_ioctl = pch_phub_ioctl, +};If would be good to add a line of
.llseek =default_llseek,
here. I have a patch to change the default llseek method to one that disallows seeking, so if you add this line, there is one less driver for me to patch.Arnd