i2c: deprecate use of union dev_config #4254
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lpereira
approved these changes
Oct 10, 2017
mnkp
reviewed
Oct 10, 2017
include/i2c.h
Outdated
| #define I2C_SPEED_SHIFT (1) | ||
| #define I2C_SPEED_SET(speed) ((speed) << I2C_SPEED_SHIFT) |
There was a problem hiding this comment.
It's customary to write _SET macros as
#define I2C_SPEED_SET(speed) (((speed) << I2C_SPEED_SHIFT) & I2C_SPEED_MASK)
to avoid unintentional overwriting of neighboring bit-fields.
include/i2c.h
Outdated
| #define I2C_SPEED_SHIFT (1) | ||
| #define I2C_SPEED_SET(speed) ((speed) << I2C_SPEED_SHIFT) | ||
| /** @cond INTERNAL_HIDDEN */ |
There was a problem hiding this comment.
Maybe we should remove @cond INTERNAL_HIDDEN? If _SET macro is visible/documented then _GET should be too.
There are several issues with the dev_config union used as a convenience when calling the i2c_configure api. One, the union is well name spaced protected and doesn't convey use with just i2c. Second there are assumptions of how the bits might get packed by the union which can't be guaranteed. Since the API takes a u32_t lets change in tree uses to using the macros to setup a u32_t and make the union as deprecated. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
galak
force-pushed
the
i2c-remove-bitfield
branch
from
459f5bc to
1fd65f0
Compare
nashif
approved these changes
Oct 11, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There are several issues with the dev_config union used as a
convenience when calling the i2c_configure api. One, the union is well
name spaced protected and doesn't convey use with just i2c. Second
there are assumptions of how the bits might get packed by the union
which can't be guaranteed. Since the API takes a u32_t lets change in
tree uses to using the macros to setup a u32_t and make the union as
deprecated.
Signed-off-by: Kumar Gala kumar.gala@linaro.org