Stlink: Clean code with unified variable type

Created on 6 Apr 2020 · 6Comments · Source: stlink-org/stlink

As far as I can see, many functions use fixed-length variables. It is indeed useful for functions that need to deal with fixed data format. However the abuse of fixed-length variables are causing potential build failures and inessential casts.

For example in src/usb.c:

send_recv accept txsize and rxsize as size_t but in the actual context, those arguments have to be casted to int or unsigned int, without a fixed length, and whoever calls it provides arguments of a different type(uint32_t or magic numbers in this case). unintentional cast from 32 bit to 64 bit is applied at the calling process. Also, to prevent a build failure, many explicit casts are required.

I suggest replacing fixed length variables according to their actual usages.
Staying fuzzy to be more portable.

I would like to give it a try if others find it meaningful.

codfeedback codrefactoring needissuer-feedback

Source

chenguokai

👍1

All 6 comments

Thx for putting this up on the agenda. As it is a general problem throughout the codebase, I'm not sure at the moment if we should put that into v1.6.1 straight away. @martonmiklos previously requested to do some cleanup related to code style, which I pushed into the v1.6.2 milestone. Maybe this would be a good place for this issue as well, though it will push it out a bit further.

Nightwalker-87 on 6 Apr 2020

Maybe I can do some cleanup locally first and follow up the develop process.😃

chenguokai on 6 Apr 2020

Well of course you can, but please ensure to branch off from develop and keep following this branch, instead of master, which is no longer used for frequent changes, but only for releases and hotfixes.

Nightwalker-87 on 6 Apr 2020

👍1

With respect to compatibility between ILP32, LLP64 and LP64 I think it would be a good idea to replace the data type long with int32_t, but if one wants to rule out surprises in the future related to conversion, we may consider to move to fixed width integer types wherever possible...

Nightwalker-87 on 9 May 2020

👍1

@chenguokai: I'll leave this to you. You may contribute, if you fancy and have some some time.

Nightwalker-87 on 3 Jun 2020

Sure I will, before the release. Getting busy now.😔

chenguokai on 7 Jun 2020

👍1

Was this page helpful?

0 / 5 - 0 ratings