ra8_bscan.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_bscan_regs.h"
#include "ra8_err.h"

typedef struct {
  bool              initialized;      
  ra8_bscan_instr_t last_instruction; 
  uint32_t          expected_idcode;  
} ra8_bscan_status_t;
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_bscan_init(void);

[[nodiscard]] ra8_err_t ra8_bscan_deinit(void);
 
/* =============================================================================
 * Read-out API
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_bscan_get_idcode(uint32_t* out);

[[nodiscard]] ra8_err_t ra8_bscan_get_status(ra8_bscan_status_t* out);

[[nodiscard]] ra8_err_t ra8_bscan_clear_status(uint32_t mask);
 
/* =============================================================================
 * Bookkeeping API
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_bscan_set_instruction(ra8_bscan_instr_t instr);
 
#ifdef __cplusplus
}
#endif