spimss.h

 
/******************************************************************************
 *
 * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
 * Analog Devices, Inc.),
 * Copyright (C) 2023-2024 Analog Devices, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/
 
/* Define to prevent redundant inclusion */
#ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32660_SPIMSS_H_
#define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32660_SPIMSS_H_
 
/* **** Includes **** */
#include "mxc_device.h"
#include "mxc_sys.h"
#include "mxc_pins.h"
#include "gpio.h"
#include "spimss_regs.h"
#include "stdbool.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* **** Definitions **** */
 
typedef enum { // ONLY FOR COMPATIBILITY FOR CONSOLIDATION WITH SPY17, NOT USED OR NEEDED
    DUMMY_1, 
    DUMMY_2, 
    DUMMY_3, 
} mxc_spimss_width_t;
 
typedef struct mxc_spimss_req mxc_spimss_req_t;
 
typedef void (*mxc_spimss_callback_fn)(mxc_spimss_req_t *req, int error_code);
 
struct mxc_spimss_req {
    uint8_t ssel; 
    uint8_t deass; 
    void *tx_data; 
    void *rx_data; 
    mxc_spimss_width_t width; 
    unsigned len; 
    unsigned bits; 
    unsigned rx_num; 
    unsigned tx_num; 
    mxc_spimss_callback_fn callback; 
};
 
/* **** Function Prototypes **** */
 
int MXC_SPIMSS_Init(mxc_spimss_regs_t *spi, unsigned mode, unsigned freq, const sys_map_t sys_cfg);
 
int MXC_SPIMSS_Shutdown(mxc_spimss_regs_t *spi);
 
int MXC_SPIMSS_MasterTrans(mxc_spimss_regs_t *spi, mxc_spimss_req_t *req);
 
int MXC_SPIMSS_MasterTransDMA(mxc_spimss_regs_t *spi, mxc_spimss_req_t *req);
 
void MXC_SPIMSS_Handler(mxc_spimss_regs_t *spi);
 
int MXC_SPIMSS_SlaveTrans(mxc_spimss_regs_t *spi, mxc_spimss_req_t *req);
 
int MXC_SPIMSS_MasterTransAsync(mxc_spimss_regs_t *spi, mxc_spimss_req_t *req);
 
int MXC_SPIMSS_SlaveTransAsync(mxc_spimss_regs_t *spi, mxc_spimss_req_t *req);
 
int MXC_SPIMSS_AbortAsync(mxc_spimss_req_t *req);
 
int MXC_SPIMSS_SetAutoDMAHandlers(mxc_spimss_regs_t *spi, bool enable);
 
int MXC_SPIMSS_SetTXDMAChannel(mxc_spimss_regs_t *spi, unsigned int channel);
 
int MXC_SPIMSS_GetTXDMAChannel(mxc_spimss_regs_t *spi);
 
int MXC_SPIMSS_SetRXDMAChannel(mxc_spimss_regs_t *spi, unsigned int channel);
 
int MXC_SPIMSS_GetRXDMAChannel(mxc_spimss_regs_t *spi);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32660_SPIMSS_H_