Kari Argillander
a2f1d6959d
* Make most of the functions const correct
Used clang-tidy and sonarlint to help find places where const could
pretty easily applied. Also lot of hand work.
This commit does not yet touch handlers and typedefs of those.
* Fix Arduino uno handler_who_is() has extra parenthesis
For some reason there is extra parenthesis. Remove it this is more
likely buildable.
* Bugfix/bacapp: Fix uninitilized array_index
We have changed bacapp_snprintf_value() to be const correct. After that
we got
```
/home/runner/work/bacnet-stack/bacnet-stack/src/bacnet/bacapp.c:3183:27: warning: 4th function call argument is an uninitialized value [core.CallAndMessage]
ret_val = bacapp_snprintf_weeklyschedule(
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1 warning generated.
```
So analyzer could now spot that we do not actually initilize array_index
at all. Fix this by setting array_index to zero. Note that I actually do
not know if zeroing is right thing to do here. I choose zero as if this
has worked before it is most likely that it will work with zero value.
* cmake: Add and ignore Wwrite-strings compiler option
Wwrite-strings helps find places where const correctness is broken.
Example it will warn about these
```C
void func1(char* str);
func("test") /* "test" is const so we should not pass it to func1().
char* func2()
{
return "test"; /* func2() should return const char*.
}
```
We still need to ignore it as not all are fixed but let's add it already
so we remember that it should be opened at some point.
---------
Co-authored-by: Kari Argillander <kari.argillander@fidelix.com>
96 lines
3.1 KiB
C
96 lines
3.1 KiB
C
/**************************************************************************
|
|
*
|
|
* Copyright (C) 2012 Steve Karg <skarg@users.sourceforge.net>
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
*
|
|
*********************************************************************/
|
|
#ifndef ETHERNET_H
|
|
#define ETHERNET_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
/* BACnet Stack defines - first */
|
|
#include "bacnet/bacdef.h"
|
|
/* BACnet Stack API */
|
|
#include "bacnet/npdu.h"
|
|
|
|
/* specific defines for Ethernet */
|
|
#define ETHERNET_HEADER_MAX (6+6+2+1+1+1)
|
|
#define ETHERNET_MPDU_MAX (ETHERNET_HEADER_MAX+MAX_PDU)
|
|
|
|
/* Unless we explicitly need these remaps to be NOT exposed
|
|
* (e.g. implementation where we need both bacnet and Zephyr symbols),
|
|
* replace the BACnet Ethernet API symbols with non-conflicting ones.
|
|
*/
|
|
#if !defined(BACNET_ETHERNET_NO_REMAP_DEFINES)
|
|
#define ethernet_valid bacnet_ethernet_valid
|
|
#define ethernet_cleanup bacnet_ethernet_cleanup
|
|
#define ethernet_init bacnet_ethernet_init
|
|
#define ethernet_send_pdu bacnet_ethernet_send_pdu
|
|
#define ethernet_receive bacnet_ethernet_receive
|
|
#define ethernet_set_my_address bacnet_ethernet_set_my_address
|
|
#define ethernet_get_my_address bacnet_ethernet_get_my_address
|
|
#define ethernet_get_broadcast_address bacnet_ethernet_get_broadcast_address
|
|
#define ethernet_debug_address bacnet_ethernet_debug_address
|
|
#define ethernet_send bacnet_ethernet_send
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool bacnet_ethernet_valid(
|
|
void);
|
|
BACNET_STACK_EXPORT
|
|
void bacnet_ethernet_cleanup(
|
|
void);
|
|
BACNET_STACK_EXPORT
|
|
bool bacnet_ethernet_init(
|
|
char *interface_name);
|
|
|
|
/* function to send a packet out the 802.2 socket */
|
|
/* returns number of bytes sent on success, negative on failure */
|
|
BACNET_STACK_EXPORT
|
|
int bacnet_ethernet_send_pdu(
|
|
BACNET_ADDRESS * dest, /* destination address */
|
|
BACNET_NPDU_DATA * npdu_data, /* network information */
|
|
uint8_t * pdu, /* any data to be sent - may be null */
|
|
unsigned pdu_len); /* number of bytes of data */
|
|
|
|
/* receives an 802.2 framed packet */
|
|
/* returns the number of octets in the PDU, or zero on failure */
|
|
BACNET_STACK_EXPORT
|
|
uint16_t bacnet_ethernet_receive(
|
|
BACNET_ADDRESS * src, /* source address */
|
|
uint8_t * pdu, /* PDU data */
|
|
uint16_t max_pdu, /* amount of space available in the PDU */
|
|
unsigned timeout); /* milliseconds to wait for a packet */
|
|
|
|
BACNET_STACK_EXPORT
|
|
void bacnet_ethernet_set_my_address(
|
|
const BACNET_ADDRESS * my_address);
|
|
BACNET_STACK_EXPORT
|
|
void bacnet_ethernet_get_my_address(
|
|
BACNET_ADDRESS * my_address);
|
|
BACNET_STACK_EXPORT
|
|
void bacnet_ethernet_get_broadcast_address(
|
|
BACNET_ADDRESS * dest); /* destination address */
|
|
|
|
/* some functions from Linux driver */
|
|
BACNET_STACK_EXPORT
|
|
void bacnet_ethernet_debug_address(
|
|
const char *info,
|
|
BACNET_ADDRESS * dest);
|
|
BACNET_STACK_EXPORT
|
|
int bacnet_ethernet_send(
|
|
uint8_t * mtu,
|
|
int mtu_len);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
#endif
|