Microchip® Advanced Software Framework

i2s_callback.h File Reference

SAM I2S - Inter-IC Sound Controller.

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

#include <i2s.h>

Enumerations

enum  i2s_job_type {
  I2S_JOB_WRITE_BUFFER,
  I2S_JOB_READ_BUFFER
}
 Enum for the possible types of I2S asynchronous jobs that may be issued to the driver. More...
 

Functions

Callback Management
static void i2s_serializer_register_callback (struct i2s_module *const module_inst, const enum i2s_serializer serializer, const i2s_serializer_callback_t callback_func, const enum i2s_serializer_callback callback_type)
 Registers a callback for serializer. More...
 
static void i2s_serializer_unregister_callback (struct i2s_module *const module_inst, const enum i2s_serializer serializer, const enum i2s_serializer_callback callback_type)
 Unregisters a callback for serializer. More...
 
static void i2s_serializer_enable_callback (struct i2s_module *const module_inst, const enum i2s_serializer serializer, const enum i2s_serializer_callback callback_type)
 Enables callback for serializer. More...
 
static void i2s_serializer_disable_callback (struct i2s_module *const module_inst, const enum i2s_serializer serializer, const enum i2s_serializer_callback callback_type)
 Disables callback for Serializer. More...
 
Job Management
enum status_code i2s_serializer_write_buffer_job (struct i2s_module *const module_inst, const enum i2s_serializer serializer, const void *buffer, const uint32_t size)
 Write buffer to the specified Serializer of I2S module. More...
 
enum status_code i2s_serializer_read_buffer_job (struct i2s_module *const module_inst, const enum i2s_serializer serializer, void *buffer, const uint32_t size)
 Read from the specified Serializer of I2S module to a buffer. More...
 
void i2s_serializer_abort_job (struct i2s_module *const module_inst, const enum i2s_serializer serializer, const enum i2s_job_type job_type)
 Aborts an ongoing job running on serializer. More...
 
enum status_code i2s_serializer_get_job_status (const struct i2s_module *const module_inst, const enum i2s_serializer serializer, const enum i2s_job_type job_type)
 Gets the status of a job running on serializer. More...