/*
 * Copyright (c) 2014, NVIDIA CORPORATION.  All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _TEGRA_PRODS_H
#define _TEGRA_PRODS_H

struct tegra_prod;

/**
 * tegra_prod_set_list(): Set all prods configurations
 * @base: List of IO mapped registers.
 * @tegra_prod: tegra_prod handle which is allocated by devm_tegra_prod_get()
 *		or tegra_prod_get_from_node();
 *
 * Configure all the prod configuration listed on prod-setting nodes.
 *
 * Returns 0 on success otherwise negive error number for failed case.
 */
int tegra_prod_set_list(void __iomem **base, struct tegra_prod *tegra_prod);

/**
 * tegra_prod_set_boot_init(): Set all prods configurations which has boot init
 *			       flag on the prod setting nodes.
 * @base: List of IO mapped registers.
 * @tegra_prod: tegra_prod handle which is allocated by devm_tegra_prod_get()
 *		or tegra_prod_get_from_node();
 *
 * Configure all the prod configuration listed on prod-setting nodes.
 *
 * Returns 0 on success otherwise negive error number for failed case.
 */
int tegra_prod_set_boot_init(void __iomem **base,
			     struct tegra_prod *tegra_prod);

/**
 * tegra_prod_set_by_name(): Set prod configuration with specific prod name.
 *			     This is used for conditional prod configurations.
 * @base: List of IO mapped registers.
 * @name: Name of conditional prod which need to be configure.
 * @tegra_prod: tegra_prod handle which is allocated by devm_tegra_prod_get()
 *		or tegra_prod_get_from_node();
 *
 * Configure prod configuration with specific prod name for conditional
 * prod configurations.
 *
 * Returns 0 on success otherwise negive error number for failed case.
 */
int tegra_prod_set_by_name(void __iomem **base, const char *name,
			   struct tegra_prod *tegra_prod);

/**
 * tegra_prod_set_by_name_partially - Set the prod setting from list partially
 *                                    under given prod name. The matching is done
 *                                    qith index, offset and mask.
 * @base:               base address of the register.
 * @name:               the name of tegra prod need to set.
 * @tegra_prod: the list of tegra prods.
 * @index:              Index of base address.
 * @offset:             Offset of the register.
 * @mask:               Mask field on given register.
 *
 * Find the tegra prod in the list according to the name. Then set
 * that tegra prod which has matching of index, offset and mask.
 *
 * Returns 0 on success.
 */
int tegra_prod_set_by_name_partially(void __iomem **base, const char *name,
				     struct tegra_prod *tegra_prod, u32 index,
				     u32 offset, u32 mask);

/**
 * tegra_prod_by_name_supported - Tell whether tegra prod will be supported by
 *				  given name or not.
 * @tegra_prod: the list of tegra prods.
 * @name:       the name of tegra prod need to set.
 *
 * Find the tegra prod in the list according to the name. If it exist then
 * return true else false.
 */
bool tegra_prod_by_name_supported(struct tegra_prod *tegra_prod,
                                  const char *name);

/**
 * devm_tegra_prod_get(): Get the prod handle from the device.
 * @dev: Device handle on which prod setting nodes are available.
 *
 * Parse the prod-setting node of the dev->of_node and keep all prod
 * setting data in prod handle.
 * This handle is used for setting prod configurations.
 *
 * Returns valid prod_list handle on success or pointer to the error
 * when it failed.
 */
struct tegra_prod *devm_tegra_prod_get(struct device *dev);

/**
 * devm_tegra_prod_get_from_node(): Get the prod handle from the node.
 * @dev: Device handle.
 * @np: Node pointer on which prod setting nodes are available.
 *
 * Parse the prod-setting node of the node pointer "np" and keep all prod
 * setting data in prod handle.
 * This handle is used for setting prod configurations.
 *
 * Returns valid prod_list handle on success or pointer to the error
 * when it failed.
 * The allocated resource is released by driver core framework when device
 * is unbinded and so no need to call any release APIs for the tegra_prod
 * handle.
 */
struct tegra_prod *devm_tegra_prod_get_from_node(struct device *dev,
						 struct device_node *np);
#endif