drv_spi_master.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
#ifndef _DRV_SPI_MASTER_H_
#define _DRV_SPI_MASTER_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "drv_name.h"
#include "generic_pointer.h"
#include "drv_digital_out.h"
#include "hal_spi_master.h"
 
typedef enum
{
    SPI_MASTER_SUCCESS = 0, 
    SPI_MASTER_ERROR = (-1) 
} spi_master_err_t;
 
typedef enum {
    SPI_MASTER_MODE_0 = 0,  
    SPI_MASTER_MODE_1,      
    SPI_MASTER_MODE_2,      
    SPI_MASTER_MODE_3,      
    SPI_MASTER_MODE_DEFAULT = SPI_MASTER_MODE_0 
} spi_master_mode_t;
 
typedef enum
{
    SPI_MASTER_CHIP_SELECT_POLARITY_ACTIVE_LOW = 0,
    SPI_MASTER_CHIP_SELECT_POLARITY_ACTIVE_HIGH,
 
    SPI_MASTER_CHIP_SELECT_DEFAULT_POLARITY = SPI_MASTER_CHIP_SELECT_POLARITY_ACTIVE_LOW
} spi_master_chip_select_polarity_t;
 
typedef struct
{
    uint8_t    default_write_data; 
    pin_name_t sck;   
    pin_name_t miso;  
    pin_name_t mosi;  
    uint32_t   speed; 
    spi_master_mode_t mode; 
} spi_master_config_t;
 
typedef struct
{
    handle_t handle; 
    spi_master_config_t config; 
} spi_master_t;
 
void spi_master_configure_default( spi_master_config_t *config );
 
err_t spi_master_open( spi_master_t *obj, spi_master_config_t *config );
 
void spi_master_select_device( pin_name_t chip_select );
 
void spi_master_deselect_device( pin_name_t chip_select );
 
void spi_master_set_chip_select_polarity( spi_master_chip_select_polarity_t polarity );
 
err_t spi_master_set_default_write_data( spi_master_t *obj, uint8_t default_write_data );
 
err_t spi_master_set_speed( spi_master_t *obj, uint32_t speed );
 
err_t spi_master_set_mode( spi_master_t *obj, spi_master_mode_t mode );
 
err_t spi_master_write( spi_master_t *obj, uint8_t * __generic_ptr write_data_buffer,
                                           size_t write_data_length );
 
err_t spi_master_read( spi_master_t *obj, uint8_t *read_data_buffer,
                                           size_t read_data_length );
 
err_t spi_master_write_then_read( spi_master_t *obj, uint8_t *write_data_buffer,
                                                     size_t length_write_data,
                                                     uint8_t *read_data_buffer,
                                                     size_t length_read_data );
 
err_t spi_master_close( spi_master_t *obj );
 
 // drvspigroup
 // drvgroup
 // pergroup
 
#ifdef __cplusplus
}
#endif
 
#endif // _DRV_SPI_MASTER_H_
// ------------------------------------------------------------------------- END