Microchip® Advanced Software Framework

picouart.h File Reference

PICOUART driver for SAM.

Copyright (c) 2012-2018 Microchip Technology Inc. and its subsidiaries.

#include "compiler.h"
#include "status_codes.h"

Data Structures

struct  picouart_config
 
struct  picouart_dev_inst
 

Enumerations

enum  picouart_actions_on_rx {
  PICOUART_ACTION_NONE = PICOUART_CFG_SOURCE(0),
  PICOUART_ACTION_WAKEUP_ON_STARTBIT = PICOUART_CFG_SOURCE(1),
  PICOUART_ACTION_WAKEUP_ON_FULLFRAME = PICOUART_CFG_SOURCE(2),
  PICOUART_ACTION_WAKEUP_ON_MATCH = PICOUART_CFG_SOURCE(3),
  PICOUART_ACTION_EVENT_ON_STARTBIT,
  PICOUART_ACTION_EVENT_ON_FULLFRAME,
  PICOUART_ACTION_EVENT_ON_MATCH
}
 

Functions

void picouart_disable (struct picouart_dev_inst *const dev_inst)
 Disable the PICOUART. More...
 
void picouart_enable (struct picouart_dev_inst *const dev_inst)
 Enable the PICOUART. More...
 
void picouart_get_config_defaults (struct picouart_config *config)
 Load a pre-defined configuration into the configuration structure. More...
 
status_code_t picouart_init (struct picouart_dev_inst *const dev_inst, Picouart *hw_dev, struct picouart_config *config)
 Initializes the PICOUART module, based on a config struct. More...
 
bool picouart_is_data_ready (struct picouart_dev_inst *const dev_inst)
 Check the data ready status of PICOUART. More...
 
bool picouart_is_enabled (struct picouart_dev_inst *const dev_inst)
 Check the enable status of PICOUART. More...
 
status_code_t picouart_read (struct picouart_dev_inst *const dev_inst, uint8_t *result)
 Get the current RHR value. More...
 
status_code_t picouart_set_config (struct picouart_dev_inst *const dev_inst, struct picouart_config *config)
 Configures the PICOUART module, based on a config struct. More...