Anh Tran / Mbed OS GR-Boards_WebCamera

test public

Dependencies:   HttpServer_snapshot_mbed-os

mbed-gr-libs/R_BSP/api/R_BSP_Ssif.h@0:e9fd5575b10e, 2019-10-18 (annotated)

Committer:
anhtran
Date:
Fri Oct 18 03:09:43 2019 +0000
Revision:
0:e9fd5575b10e
abc

Who changed what in which revision?

UserRevisionLine numberNew contents of line
anhtran 0:e9fd5575b10e 1 /*******************************************************************************
anhtran 0:e9fd5575b10e 2 * DISCLAIMER
anhtran 0:e9fd5575b10e 3 * This software is supplied by Renesas Electronics Corporation and is only
anhtran 0:e9fd5575b10e 4 * intended for use with Renesas products. No other uses are authorized. This
anhtran 0:e9fd5575b10e 5 * software is owned by Renesas Electronics Corporation and is protected under
anhtran 0:e9fd5575b10e 6 * all applicable laws, including copyright laws.
anhtran 0:e9fd5575b10e 7 * THIS SOFTWARE IS PROVIDED "AS IS" AND RENESAS MAKES NO WARRANTIES REGARDING
anhtran 0:e9fd5575b10e 8 * THIS SOFTWARE, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
anhtran 0:e9fd5575b10e 9 * LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
anhtran 0:e9fd5575b10e 10 * AND NON-INFRINGEMENT. ALL SUCH WARRANTIES ARE EXPRESSLY DISCLAIMED.
anhtran 0:e9fd5575b10e 11 * TO THE MAXIMUM EXTENT PERMITTED NOT PROHIBITED BY LAW, NEITHER RENESAS
anhtran 0:e9fd5575b10e 12 * ELECTRONICS CORPORATION NOR ANY OF ITS AFFILIATED COMPANIES SHALL BE LIABLE
anhtran 0:e9fd5575b10e 13 * FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES FOR
anhtran 0:e9fd5575b10e 14 * ANY REASON RELATED TO THIS SOFTWARE, EVEN IF RENESAS OR ITS AFFILIATES HAVE
anhtran 0:e9fd5575b10e 15 * BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
anhtran 0:e9fd5575b10e 16 * Renesas reserves the right, without notice, to make changes to this software
anhtran 0:e9fd5575b10e 17 * and to discontinue the availability of this software. By using this software,
anhtran 0:e9fd5575b10e 18 * you agree to the additional terms and conditions found by accessing the
anhtran 0:e9fd5575b10e 19 * following link:
anhtran 0:e9fd5575b10e 20 * http://www.renesas.com/disclaimer*
anhtran 0:e9fd5575b10e 21 * Copyright (C) 2015 Renesas Electronics Corporation. All rights reserved.
anhtran 0:e9fd5575b10e 22 *******************************************************************************/
anhtran 0:e9fd5575b10e 23 /**************************************************************************//**
anhtran 0:e9fd5575b10e 24 * @file R_BSP_Ssif.h
anhtran 0:e9fd5575b10e 25 * @brief SSIF API
anhtran 0:e9fd5575b10e 26 ******************************************************************************/
anhtran 0:e9fd5575b10e 27
anhtran 0:e9fd5575b10e 28 #ifndef R_BSP_SSIF_H
anhtran 0:e9fd5575b10e 29 #define R_BSP_SSIF_H
anhtran 0:e9fd5575b10e 30
anhtran 0:e9fd5575b10e 31 #include <stdint.h>
anhtran 0:e9fd5575b10e 32 #include "R_BSP_SerialFamily.h"
anhtran 0:e9fd5575b10e 33 #include "R_BSP_SsifDef.h"
anhtran 0:e9fd5575b10e 34 #include "rtos.h"
anhtran 0:e9fd5575b10e 35 #include "pinmap.h"
anhtran 0:e9fd5575b10e 36
anhtran 0:e9fd5575b10e 37 /** A class to communicate a R_BSP_Ssif
anhtran 0:e9fd5575b10e 38 *
anhtran 0:e9fd5575b10e 39 */
anhtran 0:e9fd5575b10e 40 class R_BSP_Ssif : public R_BSP_SerialFamily {
anhtran 0:e9fd5575b10e 41
anhtran 0:e9fd5575b10e 42 public:
anhtran 0:e9fd5575b10e 43
anhtran 0:e9fd5575b10e 44 /** Constructor
anhtran 0:e9fd5575b10e 45 *
anhtran 0:e9fd5575b10e 46 * @param sck SSIF serial bit clock
anhtran 0:e9fd5575b10e 47 * @param ws SSIF word selection
anhtran 0:e9fd5575b10e 48 * @param tx SSIF serial data output
anhtran 0:e9fd5575b10e 49 * @param rx SSIF serial data input
anhtran 0:e9fd5575b10e 50 */
anhtran 0:e9fd5575b10e 51 R_BSP_Ssif(PinName sck, PinName ws, PinName tx, PinName rx, PinName audio_clk = NC);
anhtran 0:e9fd5575b10e 52
anhtran 0:e9fd5575b10e 53 /** Destructor
anhtran 0:e9fd5575b10e 54 *
anhtran 0:e9fd5575b10e 55 */
anhtran 0:e9fd5575b10e 56 virtual ~R_BSP_Ssif();
anhtran 0:e9fd5575b10e 57
anhtran 0:e9fd5575b10e 58
anhtran 0:e9fd5575b10e 59 /** Initialization
anhtran 0:e9fd5575b10e 60 *
anhtran 0:e9fd5575b10e 61 * @param p_ch_cfg SSIF channel configuration parameter
anhtran 0:e9fd5575b10e 62 * @param max_write_num The upper limit of write buffer (SSIF)
anhtran 0:e9fd5575b10e 63 * @param max_read_num The upper limit of read buffer (SSIF)
anhtran 0:e9fd5575b10e 64 * @return true = success, false = failure
anhtran 0:e9fd5575b10e 65 */
anhtran 0:e9fd5575b10e 66 void init(const ssif_channel_cfg_t* const p_ch_cfg, int32_t max_write_num, int32_t max_read_num);
anhtran 0:e9fd5575b10e 67
anhtran 0:e9fd5575b10e 68 /** Get a value of SSIF channel number
anhtran 0:e9fd5575b10e 69 *
anhtran 0:e9fd5575b10e 70 * @return SSIF channel number
anhtran 0:e9fd5575b10e 71 */
anhtran 0:e9fd5575b10e 72 int32_t GetSsifChNo(void) {
anhtran 0:e9fd5575b10e 73 return ssif_ch;
anhtran 0:e9fd5575b10e 74 };
anhtran 0:e9fd5575b10e 75
anhtran 0:e9fd5575b10e 76 /** Save configuration to the SSIF driver
anhtran 0:e9fd5575b10e 77 *
anhtran 0:e9fd5575b10e 78 * @param p_ch_cfg SSIF channel configuration parameter
anhtran 0:e9fd5575b10e 79 * @return true = success, false = failure
anhtran 0:e9fd5575b10e 80 */
anhtran 0:e9fd5575b10e 81 bool ConfigChannel(const ssif_channel_cfg_t* const p_ch_cfg);
anhtran 0:e9fd5575b10e 82
anhtran 0:e9fd5575b10e 83 /** Get a value of SSISR register
anhtran 0:e9fd5575b10e 84 *
anhtran 0:e9fd5575b10e 85 * @param p_status Pointer of status value
anhtran 0:e9fd5575b10e 86 * @return true = success, false = failure
anhtran 0:e9fd5575b10e 87 */
anhtran 0:e9fd5575b10e 88 bool GetStatus(uint32_t* const p_status);
anhtran 0:e9fd5575b10e 89
anhtran 0:e9fd5575b10e 90 private:
anhtran 0:e9fd5575b10e 91 int32_t ssif_ch;
anhtran 0:e9fd5575b10e 92 };
anhtran 0:e9fd5575b10e 93 #endif