diff options
| author | Joshua Drake <joshua.ellis.drake@gmail.com> | 2024-04-23 01:27:55 -0500 |
|---|---|---|
| committer | Joshua Drake <joshua.ellis.drake@gmail.com> | 2024-04-23 01:27:55 -0500 |
| commit | 319b3a68ee64d8549524b53fba2934e94c07d19e (patch) | |
| tree | ffe9a3f58471d139a3020d0592e040242b145ab5 /mcc_generated_files/mssp2_i2c.h | |
| parent | be339d49fcfd3a09b8fdf590001e8e0f4369e4d3 (diff) | |
Added files that were forgotten in previous commits.
Diffstat (limited to 'mcc_generated_files/mssp2_i2c.h')
| -rw-r--r-- | mcc_generated_files/mssp2_i2c.h | 488 |
1 files changed, 488 insertions, 0 deletions
diff --git a/mcc_generated_files/mssp2_i2c.h b/mcc_generated_files/mssp2_i2c.h new file mode 100644 index 0000000..3fbd36c --- /dev/null +++ b/mcc_generated_files/mssp2_i2c.h @@ -0,0 +1,488 @@ +/**
+ MSSP2_I2C Generated Driver API Header File
+
+ @Company
+ Microchip Technology Inc.
+
+ @File Name
+ mssp2_i2c.h
+
+ @Summary
+ This is the generated header file for the MSSP2_I2C driver using PIC24 / dsPIC33 / PIC32MM MCUs
+
+ @Description
+ This header file provides APIs for driver for MSSP2_I2C.
+ Generation Information :
+ Product Revision : PIC24 / dsPIC33 / PIC32MM MCUs - 1.171.4
+ Device : PIC24FV16KM202
+ The generated drivers are tested against the following:
+ Compiler : XC16 v2.10
+ MPLAB : MPLAB X v6.05
+*/
+
+/*
+ (c) 2020 Microchip Technology Inc. and its subsidiaries. You may use this
+ software and any derivatives exclusively with Microchip products.
+
+ THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
+ EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
+ WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
+ PARTICULAR PURPOSE, OR ITS INTERACTION WITH MICROCHIP PRODUCTS, COMBINATION
+ WITH ANY OTHER PRODUCTS, OR USE IN ANY APPLICATION.
+
+ IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
+ INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
+ WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
+ BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
+ FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
+ ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
+ THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
+
+ MICROCHIP PROVIDES THIS SOFTWARE CONDITIONALLY UPON YOUR ACCEPTANCE OF THESE
+ TERMS.
+*/
+
+#ifndef _MSSP2_I2C_H
+#define _MSSP2_I2C_H
+
+#include <stdint.h>
+#include <stdbool.h>
+#include <stddef.h>
+#include <xc.h>
+
+#ifdef __cplusplus //* Provide C++ Compatibility */
+
+ extern "C" {
+
+#endif
+
+/**
+ I2C Slave Driver Status
+
+ @Summary
+ Defines the different status that the slave driver has
+ detected over the i2c bus.
+
+ @Description
+ This defines the different status that the slave driver has
+ detected over the i2c bus. The status is passed to the
+ MSSP2_I2C_StatusCallback() callback function that is implemented by
+ the user of the slave driver as a parameter to inform the user
+ that there was a change in the status of the driver due to
+ transactions on the i2c bus. User of the slave driver can use these
+ to manage the read or write buffers.
+
+ */
+
+typedef enum
+{
+ /* This state indicates that the slave driver has detected a transmit request from the master.
+ The next transaction will be a read transaction. Application should prime the transmit
+ buffer with the valid data to be sent to the master using the: I2C2_ReadPointerSet()
+
+ */
+ MSSP2_I2C_SLAVE_TRANSMIT_REQUEST_DETECTED,
+
+ /* This state indicates that the slave driver has detected a reception request from the master.
+ The next transaction will be a write transaction. Application should set up the receive
+ buffer by setting the location of the receive buffer using the: I2C2_WritePointerSet()
+ */
+ MSSP2_I2C_SLAVE_RECEIVE_REQUEST_DETECTED,
+
+ /* This state indicates that the slave driver has received data from the master.
+ Application can use this status to process the received data set up the receive
+ buffer in anticipation of next reception in case the master sends more data.
+ See MSSP2_I2C_SLAVE_RECEIVE_REQUEST_DETECTED.
+ */
+ MSSP2_I2C_SLAVE_RECEIVED_DATA_DETECTED,
+
+ /* This state indicates that the slave driver has detected the most significant
+ byte of the 10-bit slave address. Another transaction with the least
+ significant byte of the 10-bit address with a read/write request will
+ be detected next. This second detection is automatically done by the
+ driver which may return one of the following:
+ a. MSSP2_I2C_SLAVE_RECEIVE_REQUEST_DETECTED
+ b. MSSP2_I2C_SLAVE_TRANSMIT_REQUEST_DETECTED
+ c. MSSP2_I2C_SLAVE_10BIT_RECEIVE_REQUEST_DETECTED
+ a or b is detected depending on the read/write bit of the received
+ control data. If c is detected next, the master decided to resend
+ the most significant address.
+ */
+ MSSP2_I2C_SLAVE_10BIT_RECEIVE_REQUEST_DETECTED,
+
+} MSSP2_I2C_SLAVE_DRIVER_STATUS;
+
+#define MSSP2_I2C_SLAVE_DEFAULT_ADDRESS 0x7
+
+/**
+ @Summary
+ Initializes and enables the i2c slave instance : 2
+
+ @Description
+ This routine initializes the i2c slave driver instance for : 2
+ index, making it ready for clients to open and use it.
+
+ @Preconditions
+ None
+
+ @Param
+ None
+
+ @Returns
+ None
+
+ @Example
+ <code>
+
+ uint8_t SlaveReadBuffer;
+ uint8_t SlaveWriteBuffer;
+
+ // initialize the i2c slave driver
+ MSSP2_I2C_Initialize();
+
+ // set up the slave driver
+
+ // initialize the location of the read buffer
+ MSSP2_I2C_ReadPointerSet(SlaveReadBuffer);
+ // initialize the location of the write buffer
+ MSSP2_I2C_WritePointerSet(SlaveWriteBuffer);
+
+ </code>
+*/
+
+void MSSP2_I2C_Initialize(void);
+
+
+/**
+ @Summary
+ This function sets the slave address mask.
+
+ @Description
+ This function sets the 10-bit slave address mask to be able to
+ respond to multiple addresses. This function should be called
+ after the initialization of the module.
+
+ @Preconditions
+ None
+
+ @Param
+ mask - The address mask to be used when filtering
+ addresses from the i2c master transactions.
+
+ @Returns
+ None
+
+ @Example
+ <code>
+ Refer to MSSP2_I2C_SlaveAddressSet() for an example
+ </code>
+
+*/
+
+void MSSP2_I2C_SlaveAddressMaskSet(
+ uint16_t mask);
+
+/**
+ @Summary
+ This function sets the slave address.
+
+ @Description
+ This function sets the 10-bit slave address to be used by the
+ module when filtering transactions from the i2c masters in the
+ bus. The function analyzes the given address and decides if
+ the 10-bit or 7-bit mode will be enabled. Once the function
+ returns, the given address is set for the slave module.
+
+ This function should be called after the initialization of
+ the module.
+
+ When changing the slave address the module must be idle.
+
+ @Preconditions
+ None
+
+ @Param
+ address - The address to be used to determine if the transaction
+ is intended for this slave module.
+
+ @Returns
+ None
+
+ @Example
+ <code>
+ // initialize the i2c slave driver
+ MSSP2_I2C_Initializer();
+
+ // set the slave address and address mask if the default
+ // values set in the initialize is not the desired values.
+ MSSP2_I2C_SlaveAddressMaskSet(0x0xF);
+ MSSP2_I2C_SlaveAddressSet(0x3C);
+
+ </code>
+
+*/
+
+void MSSP2_I2C_SlaveAddressSet(
+ uint16_t address);
+
+/**
+ @Summary
+ This function sets the read pointer for the slave driver.
+
+ @Description
+ This function sets the read pointer that the driver will
+ need to retrieve data that will be transmitted to the master
+ whenever the master requests a read.
+
+ @Preconditions
+ None
+
+ @Param
+ *p - The pointer to the read buffer, that will be used to transmit
+ data to the requesting i2c master.
+
+ @Returns
+ None
+
+ @Example
+ <code>
+ Refer to MSSP2_I2C_Initialize() for an example
+ </code>
+
+*/
+
+void MSSP2_I2C_ReadPointerSet(uint8_t *p);
+
+/**
+ @Summary
+ This function sets the write pointer for the slave driver.
+
+ @Description
+ This function sets the write pointer that the driver will
+ need to save data that will be received from the master
+ whenever the master requests a write.
+
+ @Preconditions
+ None
+
+ @Param
+ *p - The pointer to the read buffer, that will be used to transmit
+ data to the requesting i2c master.
+
+ @Returns
+ None
+
+ @Example
+ <code>
+ Refer to MSSP2_I2C_Initialize() for an example
+ </code>
+
+*/
+
+void MSSP2_I2C_WritePointerSet(uint8_t *p);
+
+/**
+ @Summary
+ This function returns the current read pointer used by the
+ slave driver.
+
+ @Description
+ This function returns the current read pointer used by the
+ slave driver. As the operation executes, the pointer is
+ incremented. User of the slave driver can use this function
+ to check on the current address that the pointer is pointing to.
+
+ @Preconditions
+ None
+
+ @Param
+ None
+
+ @Returns
+ The current pointer used to transmit data to the requesting
+ i2c master
+
+ @Example
+ <code>
+ uint8_t *pReadBuffer;
+
+ pReadBuffer = MSSP2_I2C_ReadPointerGet();
+
+ </code>
+
+*/
+
+uint8_t *MSSP2_I2C_ReadPointerGet(void);
+
+/**
+ @Summary
+ This function returns the current write pointer used by the
+ slave driver.
+
+ @Description
+ This function returns the current write pointer used by the
+ slave driver. As the operation executes, the pointer is
+ incremented. User of the slave driver can use this function
+ to check on the current address that the pointer is pointing to.
+
+ @Preconditions
+ None
+
+ @Param
+ None
+
+ @Returns
+ The current pointer used to save received data from the requesting
+ i2c master
+
+ @Example
+ <code>
+ uint8_t *pWriteBuffer;
+
+ pWriteBuffer = MSSP2_I2C_WritePointerGet();
+
+ </code>
+
+*/
+
+uint8_t *MSSP2_I2C_WritePointerGet(void);
+
+/**
+ @Summary
+ This application implemented function passes the
+ status of the i2c slave driver.
+
+ @Description
+ This application implemented function passes the
+ status of the i2c slave driver. The status passed
+ can be used by the application to manage the read and
+ write buffers. This function is called by the slave
+ driver everytime there is an event in the i2c bus that caused
+ an interrupt in the i2c slave module to be asserted.
+
+ The function will return boolean. The value of the return
+ will determine if the next received byte will be ack'ed or
+ nack'ed. By doing that, the application can have the
+ ability to delay incoming transactions. When a false is
+ returned, the next transactions will be nack'ed forcing the
+ master to restart the transactions.
+
+ Returning a false will give the application a chance to
+ prepare for the next transactions (for example: a read
+ requests from the master) or process the recently received
+ data.
+
+ @Preconditions
+ None
+
+ @Param
+ status - The latest status of the slave driver due
+ to an event in the i2c bus.
+
+ @Returns
+ True, if the application is ready for the next transaction.
+ False, if the application is not ready for the next transaction.
+
+ @Example
+ <code>
+
+
+ // Example implementation of the callback
+
+ static uint8_t mssp2_i2c_slaveWriteData = 0xAA;
+
+ bool MSSP2_I2C_StatusCallback(MSSP2_I2C_SLAVE_DRIVER_STATUS status)
+ {
+
+ // this emulates the slave device memory where data written to slave
+ // is placed and data read from slave is taken
+ static uint8_t EMULATE_EEPROM_Memory[64] =
+ {
+ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ };
+
+ static uint16_t address, addrByteCount;
+ static bool addressState = true;
+
+ switch (status)
+ {
+ case MSSP2_I2C_SLAVE_TRANSMIT_REQUEST_DETECTED:
+
+ // set up the slave driver buffer transmit pointer
+ MSSP2_I2C_ReadPointerSet(&EMULATE_EEPROM_Memory[address]);
+ address++;
+
+ break;
+
+ case MSSP2_I2C_SLAVE_RECEIVE_REQUEST_DETECTED:
+
+ addrByteCount = 0;
+ addressState = true;
+
+ // set up the slave driver buffer receive pointer
+ MSSP2_I2C_WritePointerSet(&mssp2_i2c_slaveWriteData);
+
+ break;
+
+ case MSSP2_I2C_SLAVE_RECEIVED_DATA_DETECTED:
+
+ if (addressState == true)
+ {
+ // get the address of the memory being written
+ if (addrByteCount == 0)
+ {
+ address = (mssp2_i2c_slaveWriteData << 8) & 0xFF00;
+ addrByteCount++;
+ }
+ else if (addrByteCount == 1)
+ {
+ address = address | mssp2_i2c_slaveWriteData;
+ addrByteCount = 0;
+ addressState = false;
+ }
+ }
+ else // if (addressState == false)
+ {
+ // set the memory with the received data
+ EMULATE_EEPROM_Memory[address] = mssp2_i2c_slaveWriteData;
+ }
+
+ break;
+
+ case MSSP2_I2C_SLAVE_10BIT_RECEIVE_REQUEST_DETECTED:
+
+ // do something here when 10-bit address is detected
+
+ // 10-bit address is detected
+
+ break;
+
+ default:
+ break;
+
+ }
+
+ return true;
+ }
+
+ </code>
+
+ */
+
+#pragma message "MSSP2_I2C_StatusCallback() is an Application implemented function. If this function is already implemented, you can turn off this message by deleting or commenting out this message."
+bool MSSP2_I2C_StatusCallback(MSSP2_I2C_SLAVE_DRIVER_STATUS status);
+
+#ifdef __cplusplus // Provide C++ Compatibility
+
+ }
+
+#endif
+
+#endif /* _MSSP2_I2C_H */
\ No newline at end of file |