Re: [PATCH/RESEND 3/5 v4] usb: Configure endpoint according to gadget speed.

Michal Nazarewicz
2011-04-13T10:05:35Z

On Wed, 13 Apr 2011 11:56:27 +0200, Tanya Brokhman
<tlinder@codeaurora.org> wrote:

>> >+ /* find descriptors */
>> >+ for (d_spd = next_ep_desc(speed_desc); d_spd;
>> >+ d_spd = next_ep_desc(d_spd+1)) {
>>
>> this might look better if you would something like the list_for_each()
>> macro.
>
> The function next_ep_desc() goes over the endpoint descriptors (struct
> usb_descriptor_header). It's not a list so I don't see how the
> list_for_each() macro can be used here. Am I missing something?

What op[1] meant was to create a for_each_ep_desc() macro, eg. (not
tested):

#define for_each_ep_desc(it, start) \
for (it = (start); (it = next_ep_desc(it)); ++it)

>> > /**
>> >+ * config_ep_by_speed() - configures the given endpoint
>> >+ * according to gadget speed.
>> >+ * @g: pointer to the gadget
>> >+ * @f: usb function
>> >+ * @_ep: the endpoint to configure
>> >+ *
>> >+ * Return: error code, 0 on success
>> >+ *
>> >+ * This function chooses the right descriptors for a given
>> >+ * endpoint according to gadget speed and saves in in the
>> >+ * endpoint desc field. If the endpoint already has a descriptor
>> >+ * assigned to it - overwrites it with currently corresponding
>> >+ * descriptor. The endpoint maxpacket field is updated according
>> >+ * to the choosen descriptor.
>> >+ * Note: the supplied function should hold all the descriptors
>> >+ * for supported speeds
>> >+ */
>>
>> You have the same comment (including the same typo) here and in the .c.
>> Please use only on (in the .c file) as they will go async.
>
> Thanks for noticing that!
> What do you mean by "they will go async"? Is there some sort of
> automation
> that updates the comments for functions from c files to the headers?

There's none. That's the problem. Someone will modify comment in one of
them
and will forget to modify it in the other. That's why it's better to keep
comments in one place only.

[1] Also, please leave the attribution lines (the “On ... someone wrote:”
lines) in replies.

--
Best regards, _ _
.o. | Liege of Serenely Enlightened Majesty of o' \,=./ `o
..o | Computer Science, Michal "mina86" Nazarewicz (o o)
ooo +-----<email/xmpp: mnazarewicz@google.com>-----ooO--(_)--Ooo--