linux/drivers/gnss/serial.h
Gustavo A. R. Silva 9b5816b56a gnss: replace zero-length array with flexible-array
The current codebase makes use of the zero-length array language
extension to the C90 standard, but the preferred mechanism to declare
variable-length types such as these ones is a flexible array
member[1][2], introduced in C99:

struct foo {
        int stuff;
        struct boo array[];
};

By making use of the mechanism above, we will get a compiler warning in
case the flexible array does not occur last in the structure, which will
help us prevent some kind of undefined behavior bugs from being
inadvertently introduced[3] to the codebase from now on.

Also, notice that, dynamic memory allocations won't be affected by
this change:

"Flexible array members have incomplete type, and so the sizeof operator
may not be applied. As a quirk of the original implementation of
zero-length arrays, sizeof evaluates to zero."[1]

sizeof(flexible-array-member) triggers a warning because flexible array
members have incomplete type[1]. There are some instances of code in
which the sizeof operator is being incorrectly/erroneously applied to
zero-length arrays and the result is zero. Such instances may be hiding
some bugs. So, this work (flexible-array member conversions) will also
help to get completely rid of those sorts of issues.

This issue was found with the help of Coccinelle.

[1] https://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html
[2] https://github.com/KSPP/linux/issues/21
[3] commit 7649773293 ("cxgb3/l2t: Fix undefined behaviour")

Signed-off-by: Gustavo A. R. Silva <gustavoars@kernel.org>
Signed-off-by: Johan Hovold <johan@kernel.org>
2020-05-13 17:30:31 +02:00

48 lines
1.0 KiB
C

/* SPDX-License-Identifier: GPL-2.0 */
/*
* Generic serial GNSS receiver driver
*
* Copyright (C) 2018 Johan Hovold <johan@kernel.org>
*/
#ifndef _LINUX_GNSS_SERIAL_H
#define _LINUX_GNSS_SERIAL_H
#include <asm/termbits.h>
#include <linux/pm.h>
struct gnss_serial {
struct serdev_device *serdev;
struct gnss_device *gdev;
speed_t speed;
const struct gnss_serial_ops *ops;
unsigned long drvdata[];
};
enum gnss_serial_pm_state {
GNSS_SERIAL_OFF,
GNSS_SERIAL_ACTIVE,
GNSS_SERIAL_STANDBY,
};
struct gnss_serial_ops {
int (*set_power)(struct gnss_serial *gserial,
enum gnss_serial_pm_state state);
};
extern const struct dev_pm_ops gnss_serial_pm_ops;
struct gnss_serial *gnss_serial_allocate(struct serdev_device *gserial,
size_t data_size);
void gnss_serial_free(struct gnss_serial *gserial);
int gnss_serial_register(struct gnss_serial *gserial);
void gnss_serial_deregister(struct gnss_serial *gserial);
static inline void *gnss_serial_get_drvdata(struct gnss_serial *gserial)
{
return gserial->drvdata;
}
#endif /* _LINUX_GNSS_SERIAL_H */