ra8_sci_lin.h

Go to the documentation of this file.

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

typedef enum : uint8_t {
  k_ra8_sci_lin_id_max = 0x3FU, 
} ra8_sci_lin_limits_t;

typedef enum : uint8_t {
  k_ra8_sci_lin_clk_div4  = 1U, 
  k_ra8_sci_lin_clk_div16 = 2U, 
  k_ra8_sci_lin_clk_div64 = 3U, 
} ra8_sci_lin_timer_clk_t;

typedef enum : uint8_t {
  k_ra8_sci_lin_role_commander = 0U, 
  k_ra8_sci_lin_role_responder = 1U, 
} ra8_sci_lin_role_t;

typedef enum : uint8_t {
  k_ra8_sci_lin_checksum_classic  = 0U, 
  k_ra8_sci_lin_checksum_enhanced = 1U, 
} ra8_sci_lin_checksum_mode_t;

typedef struct {
  ra8_sci_cfg_t           uart;            
  ra8_sci_lin_role_t      role;            
  ra8_sci_lin_timer_clk_t timer_clk;       
  uint16_t                break_field_len; 
} ra8_sci_lin_cfg_t;
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sci_lin_init(uint8_t channel, const ra8_sci_lin_cfg_t* cfg);
 
/* =============================================================================
 * Frame transmission
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sci_lin_send_break(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_sci_lin_send_header(uint8_t channel, uint8_t id);
 
/* =============================================================================
 * Responder frame detection
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sci_lin_break_detected(uint8_t channel, bool* out_detected);

[[nodiscard]] ra8_err_t ra8_sci_lin_wait_break(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_sci_lin_clear_status(uint8_t channel);
 
/* =============================================================================
 * Response (data) phase -- either role
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sci_lin_send_response(uint8_t                     channel,
                                                  ra8_sci_lin_checksum_mode_t mode,
                                                  uint8_t                     pid,
                                                  const uint8_t*              data,
                                                  uint8_t                     len);

[[nodiscard]] ra8_err_t
ra8_sci_lin_read_response(uint8_t channel, uint8_t* out_data, uint8_t len, uint8_t* out_checksum);
 
/* =============================================================================
 * Pure helpers
 * =============================================================================
 */

[[nodiscard]] ra8_err_t
ra8_sci_lin_check_header(uint8_t sync, uint8_t pid, uint8_t* out_id, bool* out_valid);

[[nodiscard]] ra8_err_t ra8_sci_lin_check_response(ra8_sci_lin_checksum_mode_t mode,
                                                   uint8_t                     pid,
                                                   const uint8_t*              data,
                                                   uint8_t                     len,
                                                   uint8_t                     received,
                                                   bool*                       out_valid);

[[nodiscard]] uint8_t ra8_sci_lin_pid(uint8_t id);

[[nodiscard]] ra8_err_t ra8_sci_lin_checksum(ra8_sci_lin_checksum_mode_t mode,
                                             uint8_t                     pid,
                                             const uint8_t*              data,
                                             uint8_t                     len,
                                             uint8_t*                    out_checksum);
 
#ifdef __cplusplus
}
#endif