ra8_net_pal.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
 
/* =============================================================================
 * Constants
 * =============================================================================
 */

typedef enum : uint16_t {
  k_ra8_net_pal_mac_addr_len = 6U,    
  k_ra8_net_pal_mtu          = 1500U, 
  k_ra8_net_pal_frame_max    = 1518U, 
} ra8_net_pal_limits_t;

typedef enum : uint8_t {
  k_ra8_net_pal_link_down = 0U, 
  k_ra8_net_pal_link_up   = 1U, 
} ra8_net_pal_link_state_t;
 
/* =============================================================================
 * Types
 * =============================================================================
 */

/* The bytes field is read by ra8_net_pal_set_mac_addr / get_mac_addr
 * which cppcheck does not see if the test build excludes them. */
typedef struct {
  uint8_t bytes[k_ra8_net_pal_mac_addr_len]; 
} ra8_net_pal_mac_t;

typedef void (*ra8_net_pal_event_fn_t)(void* ctx, uint32_t event_mask);

typedef enum : uint32_t {
  k_ra8_net_pal_event_none      = 0x00U, 
  k_ra8_net_pal_event_link_up   = 0x01U, 
  k_ra8_net_pal_event_link_down = 0x02U, 
  k_ra8_net_pal_event_rx_ready  = 0x04U, 
  k_ra8_net_pal_event_tx_done   = 0x08U, 
  k_ra8_net_pal_event_error     = 0x10U, 
} ra8_net_pal_event_t;
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_net_pal_init(const ra8_net_pal_mac_t* mac);

[[nodiscard]] ra8_err_t ra8_net_pal_deinit(void);
 
/* =============================================================================
 * MAC address
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_net_pal_set_mac_addr(const ra8_net_pal_mac_t* mac);

[[nodiscard]] ra8_err_t ra8_net_pal_get_mac_addr(ra8_net_pal_mac_t* out_mac);
 
/* =============================================================================
 * Frame I/O
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_net_pal_send_frame(const uint8_t* frame, uint16_t len);

[[nodiscard]] ra8_err_t ra8_net_pal_recv_frame(uint8_t* out_buf, uint16_t* inout_len);
 
/* =============================================================================
 * Link state
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_net_pal_link_status(ra8_net_pal_link_state_t* out_state);
 
/* =============================================================================
 * Async event handler
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_net_pal_set_event_handler(ra8_net_pal_event_fn_t fn, void* ctx);
 
#ifdef __cplusplus
}
#endif