hal_spi_master.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2022 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 _HAL_SPI_MASTER_H_
#define _HAL_SPI_MASTER_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "hal_gpio.h"
#include "hal_target.h"
 
typedef struct
{
    handle_t *hal_spi_master_handle; 
    handle_t *drv_spi_master_handle; 
    bool      init_state;            
} hal_spi_master_handle_register_t;
 
typedef enum
{
    HAL_SPI_MASTER_MODE_0 = 0, 
    HAL_SPI_MASTER_MODE_1,     
    HAL_SPI_MASTER_MODE_2,     
    HAL_SPI_MASTER_MODE_3,     
    HAL_SPI_MASTER_MODE_DEFAULT = HAL_SPI_MASTER_MODE_0 
} hal_spi_master_mode_t;
 
typedef enum
{
    HAL_SPI_MASTER_CHIP_SELECT_POLARITY_ACTIVE_LOW = 0,                                          
    HAL_SPI_MASTER_CHIP_SELECT_POLARITY_ACTIVE_HIGH,                                             
    HAL_SPI_MASTER_CHIP_SELECT_DEFAULT_POLARITY = HAL_SPI_MASTER_CHIP_SELECT_POLARITY_ACTIVE_LOW 
} hal_spi_master_chip_select_polarity_t;
 
typedef struct
{
    uint8_t               default_write_data; 
    hal_pin_name_t        sck;                
    hal_pin_name_t        miso;               
    hal_pin_name_t        mosi;               
    uint32_t              speed;              
    hal_spi_master_mode_t mode;               
} hal_spi_master_config_t;
 
typedef struct
{
    handle_t                handle; 
    hal_spi_master_config_t config; 
} hal_spi_master_t;
 
typedef enum
{
    HAL_SPI_MASTER_SUCCESS = 0,  
    HAL_SPI_MASTER_WRONG_PINS,   
    HAL_SPI_MASTER_MODULE_ERROR, 
    HAL_SPI_MASTER_ERROR = (-1)  
} hal_spi_master_err_t;
 
void hal_spi_master_configure_default(hal_spi_master_config_t *config);
 
err_t hal_spi_master_open(handle_t *handle, bool hal_obj_open_state);
 
void hal_spi_master_select_device(hal_pin_name_t chip_select);
 
void hal_spi_master_deselect_device(hal_pin_name_t chip_select);
 
void hal_spi_master_set_chip_select_polarity(hal_spi_master_chip_select_polarity_t polarity);
 
void hal_spi_master_set_default_write_data(handle_t *handle, hal_spi_master_config_t *config);
 
err_t hal_spi_master_write(handle_t handle, uint8_t *write_data_buffer, size_t write_data_length);
 
err_t hal_spi_master_read(handle_t handle, uint8_t *read_data_buffer, size_t read_data_length);
 
err_t hal_spi_master_write_then_read(handle_t handle,
                                     uint8_t *write_data_buffer,
                                     size_t   length_write_data,
                                     uint8_t *read_data_buffer,
                                     size_t   length_read_data);
 
err_t hal_spi_master_close(handle_t *handle);
 
/*---------------------Unused Functions--------------------------------*/
 
err_t hal_spi_master_set_speed(handle_t *handle, hal_spi_master_config_t *config);
 
err_t hal_spi_master_set_mode(handle_t *handle, hal_spi_master_config_t *config);
 
 
#ifdef __cplusplus
}
#endif
 
#endif // _HAL_SPI_MASTER_H_
// ------------------------------------------------------------------------- END