Coding Style

Blog post by emitrax on Wed, 2007-05-30 11:13
,

As many of you know, I've started working even before the SoC started officially. I've already sent two patches to both my mentor (Oliver R. Dorantes) and Michael Lotz for review. One of them has already been commited by mmu_man (thanks). The second one is under review. With this latest one, the usb stack manager should be complete, as the QueueIsochronous method has been implemented, along with the CalculateBandwidth. My next move is to implement the UHCI isochronous method. Once I've done that, testing can be made. As for now, there seem to be a lack of drivers with which I can test the code. Oliver has offered himself to write some simple bluetooth driver just to test the code. Isochronous UHCI Tester are obviously welcome.

Anyway, as the post title says, I just wanted to report the only problems I had so far: Coding style! :-) At first, I struggled a little to write the code in correct Haikish style, but thanks to Michael I think I got it correctly now.

I'm also planning to help with the documentation project. Someone contacted me some weeks ago about it, but I don't remember the name anymore. Sorry! So whoever it was, please contact me again and let's see if I can help you out, as I think I have a better understanding of the USB stack now.

Stay tuned.
Salvo

Comments

Re: Coding Style

by nielx - 2007-06-01 07:23

I think I contacted you about the USB documentation. My current attempt consists of a General Introduction, the documentation of USB_spec.h and USB3.h. Comments, corrections, additions, etc. are more than welcome.

Re: Coding Style

by stippi - 2007-06-01 12:07

Hi Niels,

your documentation of how to use the USB stack is top notch! Man, I would have loved such documentation back in the BeOS days. The only irritating thing (not in your documentation, in fact it is very helpful to have it mentioned there), is the fact that different drivers are allowed to fight over the same device. When I rewrote the Wacom driver as a true usb driver, this gave me tons of problems. In the end, I had yellowTAB change their hid driver to ignore Wacom devices. Jérôme's hid driver does the same. This cannot be the final word. I will try to bring this up on the developer mailing list when I have more time. I don't know what the implications of that would be, but I think the stack should prefer "more specific" drivers over "more generic" drivers. Like for example, if there is a generic driver, which supports a certain device class, it should not be used when there is a driver which supports the vendor and model of a specific connected device, which would be handled by the generic driver just by it's class. One problem I can see is that applications, which rely on the usb_raw driver to inform the user about the current device tree, would not see devices for which there are any drivers besides usb_raw. Maybe a different solution could be invented... I mean if that is the only situation in which two drivers allowing to access the same device makes sense...

In any case, thank you very much for your excellent work on the documentation!

And thanks to you, Salvatore, for your work on the stack! Greatly appreciated!

Regards,
-Stephan