drivers/twihs/twihs.h

Go to the documentation of this file.

/*
 * Support and FAQ: visit <a href="https://www.microchip.com/support/">Microchip Support</a>
 */

#ifndef TWIHS_H_INCLUDED
#define TWIHS_H_INCLUDED

#include "compiler.h"


#ifdef __cplusplus
extern "C" {
#endif


#define TWIHS_TIMEOUT              30000

#define TWIHS_SUCCESS              0
#define TWIHS_INVALID_ARGUMENT     1
#define TWIHS_ARBITRATION_LOST     2
#define TWIHS_NO_CHIP_FOUND        3
#define TWIHS_RECEIVE_OVERRUN      4
#define TWIHS_RECEIVE_NACK         5
#define TWIHS_SEND_OVERRUN         6
#define TWIHS_SEND_NACK            7
#define TWIHS_BUSY                 8
#define TWIHS_ERROR_TIMEOUT        9

typedef struct twihs_options {
        uint32_t master_clk;
        uint32_t speed;
        uint8_t chip;
        uint8_t smbus;
} twihs_options_t;

typedef struct twihs_packet {
        uint8_t addr[3];
        uint32_t addr_length;
        void *buffer;
        uint32_t length;
        uint8_t chip;
} twihs_packet_t;

static inline void twihs_enable_smbus_quick_command(Twihs *p_twihs)
{
        p_twihs->TWIHS_CR = TWIHS_CR_QUICK;
}

static inline void twihs_enable_highspeed(Twihs *p_twihs)
{
        p_twihs->TWIHS_CR = TWIHS_CR_HSEN;
}

static inline void twihs_disable_highspeed(Twihs *p_twihs)
{
        p_twihs->TWIHS_CR = TWIHS_CR_HSDIS;
}

static inline void twihs_enable_smbus(Twihs *p_twihs)
{
        p_twihs->TWIHS_CR = TWIHS_CR_SMBEN;
}

static inline void twihs_disable_smbus(Twihs *p_twihs)
{
        p_twihs->TWIHS_CR = TWIHS_CR_SMBDIS;
}

static inline void twihs_enable_pec(Twihs *p_twihs)
{
        p_twihs->TWIHS_CR = TWIHS_CR_PECEN;
}

static inline void twihs_disable_pec(Twihs *p_twihs)
{
        p_twihs->TWIHS_CR = TWIHS_CR_PECDIS;
}

static inline void twihs_request_pec(Twihs *p_twihs)
{
        p_twihs->TWIHS_CR = TWIHS_CR_PECRQ;
}

static inline void twihs_send_clear(Twihs *p_twihs)
{
        p_twihs->TWIHS_CR = TWIHS_CR_CLEAR;
}

#if !(SAMV70 || SAMV71 || SAME70 || SAMS70)

static inline void twihs_enable_alternative_command(Twihs *p_twihs)
{
        p_twihs->TWIHS_CR = TWIHS_CR_ACMEN;
}

static inline void twihs_disable_alternative_command(Twihs *p_twihs)
{
        p_twihs->TWIHS_CR = TWIHS_CR_ACMDIS;
}
#endif

static inline void twihs_disable_slave_nack(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR &= ~TWIHS_SMR_NACKEN;
}

static inline void twihs_enable_slave_nack(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR |= TWIHS_SMR_NACKEN;
}

static inline void twihs_disable_slave_default_addr(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR &= ~TWIHS_SMR_SMDA;
}

static inline void twihs_enable_slave_default_addr(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR |= TWIHS_SMR_SMDA;
}

static inline void twihs_disable_smbus_host_header(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR &= ~TWIHS_SMR_SMHH;
}

static inline void twihs_enable_smbus_host_header(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR |= TWIHS_SMR_SMHH;
}

static inline void twihs_disable_clock_wait_state(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR |= TWIHS_SMR_SCLWSDIS;
}

static inline void twihs_clear_disable_clock_wait_state(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR &= ~TWIHS_SMR_SCLWSDIS;
}

#if (SAMG53 || SAMG54 || SAMV70 || SAMV71 || SAME70 || SAMS70)

static inline void twihs_disable_slave_addr1_matching(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR &= ~TWIHS_SMR_SADR1EN;
}

static inline void twihs_enable_slave_addr1_matching(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR |= TWIHS_SMR_SADR1EN;
}

static inline void twihs_disable_slave_addr2_matching(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR &= ~TWIHS_SMR_SADR2EN;
}

static inline void twihs_enable_slave_addr2_matching(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR |= TWIHS_SMR_SADR2EN;
}

static inline void twihs_disable_slave_addr3_matching(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR &= ~TWIHS_SMR_SADR3EN;
}

static inline void twihs_enable_slave_addr3_matching(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR |= TWIHS_SMR_SADR3EN;
}

static inline void twihs_disable_slave_data_matching(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR &= ~TWIHS_SMR_DATAMEN;
}

static inline void twihs_enable_slave_data_matching(Twihs *p_twihs)
{
        p_twihs->TWIHS_SMR |= TWIHS_SMR_DATAMEN;
}

void twihs_set_sleepwalking(Twihs *p_twihs,
                uint32_t ul_matching_addr1, bool flag1,
                uint32_t ul_matching_addr2, bool flag2,
                uint32_t ul_matching_addr3, bool flag3,
                uint32_t ul_matching_data, bool flag);
#endif

void twihs_enable_master_mode(Twihs *p_twihs);
void twihs_disable_master_mode(Twihs *p_twihs);
uint32_t twihs_master_init(Twihs *p_twihs, const twihs_options_t *p_opt);
uint32_t twihs_set_speed(Twihs *p_twihs, uint32_t ul_speed, uint32_t ul_mck);
uint32_t twihs_probe(Twihs *p_twihs, uint8_t uc_slave_addr);
uint32_t twihs_master_read(Twihs *p_twihs, twihs_packet_t *p_packet);
uint32_t twihs_master_write(Twihs *p_twihs, twihs_packet_t *p_packet);
void twihs_enable_interrupt(Twihs *p_twihs, uint32_t ul_sources);
void twihs_disable_interrupt(Twihs *p_twihs, uint32_t ul_sources);
uint32_t twihs_get_interrupt_status(Twihs *p_twihs);
uint32_t twihs_get_interrupt_mask(Twihs *p_twihs);
uint8_t twihs_read_byte(Twihs *p_twihs);
void twihs_write_byte(Twihs *p_twihs, uint8_t uc_byte);
void twihs_enable_slave_mode(Twihs *p_twihs);
void twihs_disable_slave_mode(Twihs *p_twihs);
void twihs_slave_init(Twihs *p_twihs, uint32_t ul_device_addr);
void twihs_set_slave_addr(Twihs *p_twihs, uint32_t ul_device_addr);
uint32_t twihs_slave_read(Twihs *p_twihs, uint8_t *p_data);
uint32_t twihs_slave_write(Twihs *p_twihs, uint8_t *p_data);
void twihs_reset(Twihs *p_twihs);
#if !(SAMV70 || SAMV71 || SAME70 || SAMS70)
Pdc *twihs_get_pdc_base(Twihs *p_twihs);
#endif
void twihs_set_write_protection(Twihs *p_twihs, bool flag);
void twihs_read_write_protection_status(Twihs *p_twihs, uint32_t *p_status);
void twihs_smbus_set_timing(Twihs *p_twihs, uint32_t ul_timing);
#if !(SAMV70 || SAMV71 || SAME70 || SAMS70)
void twihs_set_alternative_command(Twihs *p_twihs, uint32_t ul_alt_cmd);
#endif
void twihs_set_filter(Twihs *p_twihs, uint32_t ul_filter);
void twihs_mask_slave_addr(Twihs *p_twihs, uint32_t ul_mask);



#ifdef __cplusplus
}
#endif


#endif /* TWIHS_H_INCLUDED */