Pratyush Mallick / Mbed OS testing

this is testing

app/noos_mbed/util/clk.c@0:3afcd581558d, 2021-01-14 (annotated)

Committer:
pmallick
Date:
Thu Jan 14 18:54:16 2021 +0530
Revision:
0:3afcd581558d
this is testing

Who changed what in which revision?

UserRevisionLine numberNew contents of line
pmallick 0:3afcd581558d 1 /***************************************************************************//**
pmallick 0:3afcd581558d 2 * @file clk.c
pmallick 0:3afcd581558d 3 * @brief Implementation of Clock Driver.
pmallick 0:3afcd581558d 4 * @author DBogdan (dragos.bogdan@analog.com)
pmallick 0:3afcd581558d 5 ********************************************************************************
pmallick 0:3afcd581558d 6 * Copyright 2020(c) Analog Devices, Inc.
pmallick 0:3afcd581558d 7 *
pmallick 0:3afcd581558d 8 * All rights reserved.
pmallick 0:3afcd581558d 9 *
pmallick 0:3afcd581558d 10 * Redistribution and use in source and binary forms, with or without
pmallick 0:3afcd581558d 11 * modification, are permitted provided that the following conditions are met:
pmallick 0:3afcd581558d 12 * - Redistributions of source code must retain the above copyright
pmallick 0:3afcd581558d 13 * notice, this list of conditions and the following disclaimer.
pmallick 0:3afcd581558d 14 * - Redistributions in binary form must reproduce the above copyright
pmallick 0:3afcd581558d 15 * notice, this list of conditions and the following disclaimer in
pmallick 0:3afcd581558d 16 * the documentation and/or other materials provided with the
pmallick 0:3afcd581558d 17 * distribution.
pmallick 0:3afcd581558d 18 * - Neither the name of Analog Devices, Inc. nor the names of its
pmallick 0:3afcd581558d 19 * contributors may be used to endorse or promote products derived
pmallick 0:3afcd581558d 20 * from this software without specific prior written permission.
pmallick 0:3afcd581558d 21 * - The use of this software may or may not infringe the patent rights
pmallick 0:3afcd581558d 22 * of one or more patent holders. This license does not release you
pmallick 0:3afcd581558d 23 * from the requirement that you obtain separate licenses from these
pmallick 0:3afcd581558d 24 * patent holders to use this software.
pmallick 0:3afcd581558d 25 * - Use of the software either in source or binary form, must be run
pmallick 0:3afcd581558d 26 * on or directly connected to an Analog Devices Inc. component.
pmallick 0:3afcd581558d 27 *
pmallick 0:3afcd581558d 28 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
pmallick 0:3afcd581558d 29 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
pmallick 0:3afcd581558d 30 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
pmallick 0:3afcd581558d 31 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
pmallick 0:3afcd581558d 32 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
pmallick 0:3afcd581558d 33 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
pmallick 0:3afcd581558d 34 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
pmallick 0:3afcd581558d 35 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
pmallick 0:3afcd581558d 36 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
pmallick 0:3afcd581558d 37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
pmallick 0:3afcd581558d 38 *******************************************************************************/
pmallick 0:3afcd581558d 39
pmallick 0:3afcd581558d 40 /******************************************************************************/
pmallick 0:3afcd581558d 41 /***************************** Include Files **********************************/
pmallick 0:3afcd581558d 42 /******************************************************************************/
pmallick 0:3afcd581558d 43 #include "error.h"
pmallick 0:3afcd581558d 44 #include "clk.h"
pmallick 0:3afcd581558d 45
pmallick 0:3afcd581558d 46 /******************************************************************************/
pmallick 0:3afcd581558d 47 /************************** Functions Implementation **************************/
pmallick 0:3afcd581558d 48 /******************************************************************************/
pmallick 0:3afcd581558d 49
pmallick 0:3afcd581558d 50 /**
pmallick 0:3afcd581558d 51 * Start the clock.
pmallick 0:3afcd581558d 52 * @param clk - The clock structure.
pmallick 0:3afcd581558d 53 * @return SUCCESS in case of success, negative error code otherwise.
pmallick 0:3afcd581558d 54 */
pmallick 0:3afcd581558d 55 int32_t clk_enable(struct clk * clk)
pmallick 0:3afcd581558d 56 {
pmallick 0:3afcd581558d 57 if (clk->hw->dev_clk_enable)
pmallick 0:3afcd581558d 58 return clk->hw->dev_clk_enable(clk->hw->dev);
pmallick 0:3afcd581558d 59 else
pmallick 0:3afcd581558d 60 return FAILURE;
pmallick 0:3afcd581558d 61 }
pmallick 0:3afcd581558d 62
pmallick 0:3afcd581558d 63 /**
pmallick 0:3afcd581558d 64 * Stop the clock.
pmallick 0:3afcd581558d 65 * @param clk - The clock structure.
pmallick 0:3afcd581558d 66 * @return SUCCESS in case of success, negative error code otherwise.
pmallick 0:3afcd581558d 67 */
pmallick 0:3afcd581558d 68 int32_t clk_disable(struct clk * clk)
pmallick 0:3afcd581558d 69 {
pmallick 0:3afcd581558d 70 if (clk->hw->dev_clk_disable)
pmallick 0:3afcd581558d 71 return clk->hw->dev_clk_disable(clk->hw->dev);
pmallick 0:3afcd581558d 72 else
pmallick 0:3afcd581558d 73 return FAILURE;
pmallick 0:3afcd581558d 74 }
pmallick 0:3afcd581558d 75
pmallick 0:3afcd581558d 76 /**
pmallick 0:3afcd581558d 77 * Get the current frequency of the clock.
pmallick 0:3afcd581558d 78 * @param clk - The clock structure.
pmallick 0:3afcd581558d 79 * @param rate - The current frequency.
pmallick 0:3afcd581558d 80 * @return SUCCESS in case of success, negative error code otherwise.
pmallick 0:3afcd581558d 81 */
pmallick 0:3afcd581558d 82 int32_t clk_recalc_rate(struct clk *clk,
pmallick 0:3afcd581558d 83 uint64_t *rate)
pmallick 0:3afcd581558d 84 {
pmallick 0:3afcd581558d 85 if (clk->hw->dev_clk_recalc_rate)
pmallick 0:3afcd581558d 86 return clk->hw->dev_clk_recalc_rate(clk->hw->dev,
pmallick 0:3afcd581558d 87 clk->hw_ch_num,
pmallick 0:3afcd581558d 88 rate);
pmallick 0:3afcd581558d 89 else
pmallick 0:3afcd581558d 90 return FAILURE;
pmallick 0:3afcd581558d 91 }
pmallick 0:3afcd581558d 92
pmallick 0:3afcd581558d 93 /**
pmallick 0:3afcd581558d 94 * Round the desired frequency to a rate that the clock can actually output.
pmallick 0:3afcd581558d 95 * @param clk - The clock structure.
pmallick 0:3afcd581558d 96 * @param rate - The desired frequency.
pmallick 0:3afcd581558d 97 * @param rounded_rate - The rounded frequency.
pmallick 0:3afcd581558d 98 * @return SUCCESS in case of success, negative error code otherwise.
pmallick 0:3afcd581558d 99 */
pmallick 0:3afcd581558d 100 int32_t clk_round_rate(struct clk *clk,
pmallick 0:3afcd581558d 101 uint64_t rate,
pmallick 0:3afcd581558d 102 uint64_t *rounded_rate)
pmallick 0:3afcd581558d 103 {
pmallick 0:3afcd581558d 104 if (clk->hw->dev_clk_round_rate)
pmallick 0:3afcd581558d 105 return clk->hw->dev_clk_round_rate(clk->hw->dev,
pmallick 0:3afcd581558d 106 clk->hw_ch_num,
pmallick 0:3afcd581558d 107 rate,
pmallick 0:3afcd581558d 108 rounded_rate);
pmallick 0:3afcd581558d 109 else
pmallick 0:3afcd581558d 110 return FAILURE;
pmallick 0:3afcd581558d 111 }
pmallick 0:3afcd581558d 112
pmallick 0:3afcd581558d 113 /**
pmallick 0:3afcd581558d 114 * Change the frequency of the clock.
pmallick 0:3afcd581558d 115 * @param clk - The clock structure.
pmallick 0:3afcd581558d 116 * @param rate - The desired frequency.
pmallick 0:3afcd581558d 117 * @return SUCCESS in case of success, negative error code otherwise.
pmallick 0:3afcd581558d 118 */
pmallick 0:3afcd581558d 119 int32_t clk_set_rate(struct clk *clk,
pmallick 0:3afcd581558d 120 uint64_t rate)
pmallick 0:3afcd581558d 121 {
pmallick 0:3afcd581558d 122 if (clk->hw->dev_clk_set_rate)
pmallick 0:3afcd581558d 123 return clk->hw->dev_clk_set_rate(clk->hw->dev,
pmallick 0:3afcd581558d 124 clk->hw_ch_num,
pmallick 0:3afcd581558d 125 rate);
pmallick 0:3afcd581558d 126 else
pmallick 0:3afcd581558d 127 return FAILURE;
pmallick 0:3afcd581558d 128 }