Skip to contentSkip to conversation

net:ethernet:intel:Remove outdated fix me comment in the function, gb_acquire_swfw_sync_i210

PATCH In review Nicholas Krause 5 participants 11 messages Feb 8, 2015 – Feb 9, 2015

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 net:ethernet:intel:Remove outdated fix me comment in the function, gb_acquire_swfw_sync_i210

Removes the outdated fix me comment in the function,gb_acquire_swfw_sync_i210 for setting the variables, i and timeout to the intended correct values for the function,gb_acquire_swfw_sync_i210 to function correctly. This comment is no longer due to these values having been no changed in the last few years and no known issues have been found for these variables being set to their current values. Due to this the comment can now be removed as the values set for these variables are known to be correct after years of no known issues or bugs related to their current values.

---
 drivers/net/ethernet/intel/igb/e1000_i210.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/net/ethernet/intel/igb/e1000_i210.c +1 -1
index 65d9316..0c169e5 100644
@@ -140,7 +140,7 @@ s32 igb_acquire_swfw_sync_i210(struct e1000_hw *hw, u16 mask)
 	u32 swmask = mask;
 	u32 fwmask = mask << 16;
 	s32 ret_val = 0;
-	s32 i = 0, timeout = 200; /* FIXME: find real value to use here */
+	s32 i = 0, timeout = 200;
 
 	while (i < timeout) {
 		if (igb_get_hw_semaphore_i210(hw)) {
Signature · 14 lines
2.1.0


------------------------------------------------------------------------------
Dive into the World of Parallel Programming. The Go Parallel Website,
sponsored by Intel and developed in partnership with Slashdot Media, is your
hub for all things parallel software development, from weekly thought
leadership blogs to news, videos, case studies, tutorials and more. Take a
look and join the conversation now. http://goparallel.sourceforge.net/
_______________________________________________
E1000-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/e1000-devel
To learn more about Intel&#174; Ethernet, visit http://communities.intel.com/community/wired
#1 lore raw

Re: [PATCH] net:ethernet:intel:Remove outdated fix me comment in the function,gb_acquire_swfw_sync_i210

Quoted 16 lines · Nicholas Krause

Removes the outdated fix me comment in the function,gb_acquire_swfw_sync_i210
for setting the variables, i and timeout to the intended correct values for
the function,gb_acquire_swfw_sync_i210 to function correctly. This comment is
no longer due to these values having been no changed in the last few years and
no known issues have been found for these variables being set to their current
values. Due to this the comment can now be removed as the values set for these
variables are known to be correct after years of no known issues or bugs related
to their current values.

Quoted 4 lines
---
 drivers/net/ethernet/intel/igb/e1000_i210.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Thank Nick, I will add your patch to my queue.

------------------------------------------------------------------------------
Dive into the World of Parallel Programming. The Go Parallel Website, sponsored by Intel and developed in partnership with Slashdot Media, is your hub for all things parallel software development, from weekly thought leadership blogs to news, videos, case studies, tutorials and more. Take a look and join the conversation now. http://goparallel.sourceforge.net/

_______________________________________________
E1000-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/e1000-devel
To learn more about Intel&#174; Ethernet, visit http://communities.intel.com/community/wired

#2 lore raw
Quoted 17 lines · Jeff Kirsher
Quoted 16 lines · Nicholas Krause

Removes the outdated fix me comment in the function,gb_acquire_swfw_sync_i210
for setting the variables, i and timeout to the intended correct values for
the function,gb_acquire_swfw_sync_i210 to function correctly. This comment is
no longer due to these values having been no changed in the last few years and
no known issues have been found for these variables being set to their current
values. Due to this the comment can now be removed as the values set for these
variables are known to be correct after years of no known issues or bugs related
to their current values.

Quoted 6 lines
Quoted 4 lines
---
 drivers/net/ethernet/intel/igb/e1000_i210.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Thank Nick, I will add your patch to my queue.

Oh and the title should be "igb: Remove outdated ...", not "net:ethernet:intel: Remove ..."

------------------------------------------------------------------------------
Dive into the World of Parallel Programming. The Go Parallel Website, sponsored by Intel and developed in partnership with Slashdot Media, is your hub for all things parallel software development, from weekly thought leadership blogs to news, videos, case studies, tutorials and more. Take a look and join the conversation now. http://goparallel.sourceforge.net/

_______________________________________________
E1000-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/e1000-devel
To learn more about Intel&#174; Ethernet, visit http://communities.intel.com/community/wired

author
#3 lore raw
Quoted 23 lines · Jeff Kirsher
Quoted 22 lines · Jeff Kirsher
Quoted 20 lines · Nicholas Krause

Removes the outdated fix me comment in the function,gb_acquire_swfw_sync_i210
for setting the variables, i and timeout to the intended correct values for
the function,gb_acquire_swfw_sync_i210 to function correctly. This comment is
no longer due to these values having been no changed in the last few years and
no known issues have been found for these variables being set to their current
values. Due to this the comment can now be removed as the values set for these
variables are known to be correct after years of no known issues or bugs related
to their current values.

---
 drivers/net/ethernet/intel/igb/e1000_i210.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 5 lines
Quoted 1 line

Thank Nick, I will add your patch to my queue.

Oh and the title should be "igb: Remove outdated ...", not "net:ethernet:intel: Remove ..."

Jeff,
Sorry about the title. Good to known for next time. Should I resend or will you fix the title for me?
Cheers,
Nick

------------------------------------------------------------------------------
Dive into the World of Parallel Programming. The Go Parallel Website, sponsored by Intel and developed in partnership with Slashdot Media, is your hub for all things parallel software development, from weekly thought leadership blogs to news, videos, case studies, tutorials and more. Take a look and join the conversation now. http://goparallel.sourceforge.net/
_______________________________________________
E1000-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/e1000-devel
To learn more about Intel&#174; Ethernet, visit http://communities.intel.com/community/wired

#4 lore raw
Quoted 27 lines · nick
Quoted 25 lines · Jeff Kirsher
Quoted 23 lines · Jeff Kirsher
Quoted 16 lines · Nicholas Krause

Removes the outdated fix me comment in the function,gb_acquire_swfw_sync_i210
for setting the variables, i and timeout to the intended correct values for
the function,gb_acquire_swfw_sync_i210 to function correctly. This comment is
no longer due to these values having been no changed in the last few years and
no known issues have been found for these variables being set to their current
values. Due to this the comment can now be removed as the values set for these
variables are known to be correct after years of no known issues or bugs related
to their current values.

Quoted 4 lines
---
 drivers/net/ethernet/intel/igb/e1000_i210.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Thank Nick, I will add your patch to my queue.

Quoted 8 lines
Quoted 3 lines

Oh and the title should be "igb: Remove outdated ...", not "net:ethernet:intel: Remove ..."

Jeff,
Sorry about the title. Good to known for next time. Should I resend or will you fix the title for me?
Cheers,
Nick

I will fix the title.

#5 lore raw

Re: [PATCH] net:ethernet:intel:Remove outdated fix me comment in the function,gb_acquire_swfw_sync_i210

In reply to Jeff Kirsher

Hi,

Can you please leave full patch with git diff when you're replying to Nicks e-mails? Nick is banned in *@vger.kernel.org so we cannot see his patches and rest of the world is seeing only replyies to his e-mail. And it's really hard to test anything when we don't see changes.

Quoted 24 lines · Jeff Kirsher
Quoted 16 lines · Nicholas Krause

Removes the outdated fix me comment in the function,gb_acquire_swfw_sync_i210
for setting the variables, i and timeout to the intended correct values for
the function,gb_acquire_swfw_sync_i210 to function correctly. This comment is
no longer due to these values having been no changed in the last few years and
no known issues have been found for these variables being set to their current
values. Due to this the comment can now be removed as the values set for these
variables are known to be correct after years of no known issues or bugs related
to their current values.

Quoted 4 lines
---
 drivers/net/ethernet/intel/igb/e1000_i210.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Thank Nick, I will add your patch to my queue.

Signature · 2 lines
Kind regards,
b.
#6 lore raw

Re: [PATCH] net:ethernet:intel:Remove outdated fix me comment in the function,gb_acquire_swfw_sync_i210

Quoted 6 lines · Andrej Manduch

Hi,

Can you please leave full patch with git diff when you're replying to Nicks e-mails? Nick is banned in *@vger.kernel.org so we cannot see his patches and rest of the world is seeing only replyies to his e-mail. And it's really hard to test anything when we don't see changes.

Oh, I am well aware of Nick's current ban on @vger,kernel.org mailing lists. If you want to see Nick's patch, feel free to view his patch on my queue tree:
https://git.kernel.org/cgit/linux/kernel/git/jkirsher/queue.git/

It is the top most patch (i.e. last one applied to my queue).

Quoted 27 lines · Jeff Kirsher
Quoted 24 lines · Nicholas Krause
Quoted 16 lines

Removes the outdated fix me comment in the function,gb_acquire_swfw_sync_i210
for setting the variables, i and timeout to the intended correct values for
the function,gb_acquire_swfw_sync_i210 to function correctly. This comment is
no longer due to these values having been no changed in the last few years and
no known issues have been found for these variables being set to their current
values. Due to this the comment can now be removed as the values set for these
variables are known to be correct after years of no known issues or bugs related
to their current values.

Quoted 4 lines
---
 drivers/net/ethernet/intel/igb/e1000_i210.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Thank Nick, I will add your patch to my queue.

#7 lore raw

Re: [PATCH] net:ethernet:intel:Remove outdated fix me comment in the function,gb_acquire_swfw_sync_i210

Quoted 3 lines · Jeff Kirsher

If you want to see Nick's patch, feel free to view his patch on my queue tree:
https://git.kernel.org/cgit/linux/kernel/git/jkirsher/queue.git/

which said:
- s32 i = 0, timeout = 200; /* FIXME: find real value to use here */
+ s32 i = 0, timeout = 200;

Comments like the one deleted by that patch do have some value in my
opinion: They document that the constant is chosen arbitrarily and is not taken from some datasheet.

Not a big deal, but leaving such comments, even if the value never ever changes, could save someone from trying to figure out where the heck you got that constant. And there's noone actually misinterpreting this comment as "something needs to be fixed here", is there? So the cost of leaving the comment is exactly zero.

Just my .02 €. I'm not going to tell you how to maintain your driver, of course. At least I try not to :-)

Bjørn

#8 lore raw

Re: [PATCH] net:ethernet:intel:Remove outdated fix me comment in the function,gb_acquire_swfw_sync_i210

Quoted 24 lines · Bjørn Mork
Quoted 3 lines · Jeff Kirsher

If you want to see Nick's patch, feel free to view his patch on my queue tree:
https://git.kernel.org/cgit/linux/kernel/git/jkirsher/queue.git/

which said:
- s32 i = 0, timeout = 200; /* FIXME: find real value to use here */
+ s32 i = 0, timeout = 200;

Comments like the one deleted by that patch do have some value in my
opinion: They document that the constant is chosen arbitrarily and is not taken from some datasheet.

Not a big deal, but leaving such comments, even if the value never ever
changes, could save someone from trying to figure out where the heck you
got that constant. And there's noone actually misinterpreting this comment as "something needs to be fixed here", is there? So the cost of
leaving the comment is exactly zero.

Quoted 2 lines

Just my .02 €. I'm not going to tell you how to maintain your driver, of course. At least I try not to :-)

I see your point and I will have Carolyn take look to see if the comment should rather be changed to see if we can describe why the value and remove the FIXME at the same time.

#9 lore raw
In reply to Bjørn Mork
Quoted 15 lines · Bj?rn Mork
Quoted 3 lines · Jeff Kirsher

If you want to see Nick's patch, feel free to view his patch on my queue tree:
https://git.kernel.org/cgit/linux/kernel/git/jkirsher/queue.git/

which said:
- s32 i = 0, timeout = 200; /* FIXME: find real value to use here */
+ s32 i = 0, timeout = 200;

Comments like the one deleted by that patch do have some value in my
opinion: They document that the constant is chosen arbitrarily and is not taken from some datasheet.

Quoted 8 lines

Not a big deal, but leaving such comments, even if the value never ever changes, could save someone from trying to figure out where the heck you got that constant. And there's noone actually misinterpreting this comment as "something needs to be fixed here", is there? So the cost of leaving the comment is exactly zero.

Just my .02 ?. I'm not going to tell you how to maintain your driver, of course. At least I try not to :-)

I think, for now, we should NAK this. It's a short comment and you don't want me to replace it with a philosophical statement on how you could tune the timeout. That's what the data sheet is for.

(Replying from my home account and not my work account - [email protected])

------------------------------------------------------------------------------
Dive into the World of Parallel Programming. The Go Parallel Website, sponsored by Intel and developed in partnership with Slashdot Media, is your hub for all things parallel software development, from weekly thought leadership blogs to news, videos, case studies, tutorials and more. Take a look and join the conversation now. http://goparallel.sourceforge.net/
_______________________________________________
E1000-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/e1000-devel
To learn more about Intel&#174; Ethernet, visit http://communities.intel.com/community/wired

#10 lore raw
Quoted 33 lines · Hisashi T Fujinaka
Quoted 15 lines · Bj?rn Mork
Quoted 3 lines · Jeff Kirsher

If you want to see Nick's patch, feel free to view his patch on my queue tree:
https://git.kernel.org/cgit/linux/kernel/git/jkirsher/queue.git/

which said:
- s32 i = 0, timeout = 200; /* FIXME: find real value to use here */
+ s32 i = 0, timeout = 200;

Comments like the one deleted by that patch do have some value in my
opinion: They document that the constant is chosen arbitrarily and is not taken from some datasheet.

Quoted 8 lines

Not a big deal, but leaving such comments, even if the value never ever changes, could save someone from trying to figure out where the heck you got that constant. And there's noone actually misinterpreting this comment as "something needs to be fixed here", is there? So the cost of leaving the comment is exactly zero.

Just my .02 ?. I'm not going to tell you how to maintain your driver, of course. At least I try not to :-)

I think, for now, we should NAK this. It's a short comment and you don't want me to replace it with a philosophical statement on how you could tune the timeout. That's what the data sheet is for.

(Replying from my home account and not my work account - [email protected])

Quoted 11 lines

------------------------------------------------------------------------------
Dive into the World of Parallel Programming. The Go Parallel Website, sponsored by Intel and developed in partnership with Slashdot Media, is your hub for all things parallel software development, from weekly thought leadership blogs to news, videos, case studies, tutorials and more. Take a look and join the conversation now. http://goparallel.sourceforge.net/
_______________________________________________
E1000-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/e1000-devel
To learn more about Intel&#174; Ethernet, visit http://communities.intel.com/community/wired

That's fine, however if that is the case why not just explain the reasons for these values in
another patch with a added comment rather then just removing the FIXME.
Nick

------------------------------------------------------------------------------
Dive into the World of Parallel Programming. The Go Parallel Website, sponsored by Intel and developed in partnership with Slashdot Media, is your hub for all things parallel software development, from weekly thought leadership blogs to news, videos, case studies, tutorials and more. Take a look and join the conversation now. http://goparallel.sourceforge.net/
_______________________________________________
E1000-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/e1000-devel
To learn more about Intel&#174; Ethernet, visit http://communities.intel.com/community/wired