drivers/bus/fslmc/mc/fsl_dpmng.h

   1 /*-
   2  * This file is provided under a dual BSD/GPLv2 license. When using or
   3  * redistributing this file, you may do so under either license.
   4  *
   5  *   BSD LICENSE
   6  *
   7  * Copyright 2013-2015 Freescale Semiconductor Inc.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions are met:
  11  * * Redistributions of source code must retain the above copyright
  12  * notice, this list of conditions and the following disclaimer.
  13  * * Redistributions in binary form must reproduce the above copyright
  14  * notice, this list of conditions and the following disclaimer in the
  15  * documentation and/or other materials provided with the distribution.
  16  * * Neither the name of the above-listed copyright holders nor the
  17  * names of any contributors may be used to endorse or promote products
  18  * derived from this software without specific prior written permission.
  19  *
  20  *   GPL LICENSE SUMMARY
  21  *
  22  * ALTERNATIVELY, this software may be distributed under the terms of the
  23  * GNU General Public License ("GPL") as published by the Free Software
  24  * Foundation, either version 2 of that License or (at your option) any
  25  * later version.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  28  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  31  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  37  * POSSIBILITY OF SUCH DAMAGE.
  38  */
  39 #ifndef __FSL_DPMNG_H
  40 #define __FSL_DPMNG_H
  41
  42 /* Management Complex General API
  43  * Contains general API for the Management Complex firmware
  44  */
  45
  46 struct fsl_mc_io;
  47
  48 /**
  49  * Management Complex firmware version information
  50  */
  51 #define MC_VER_MAJOR 10
  52 #define MC_VER_MINOR 1
  53
  54 /**
  55  * struct mc_versoin
  56  * @major: Major version number: incremented on API compatibility changes
  57  * @minor: Minor version number: incremented on API additions (that are
  58  *              backward compatible); reset when major version is incremented
  59  * @revision: Internal revision number: incremented on implementation changes
  60  *              and/or bug fixes that have no impact on API
  61  */
  62 struct mc_version {
  63         uint32_t major;
  64         uint32_t minor;
  65         uint32_t revision;
  66 };
  67
  68 /**
  69  * struct mc_platform
  70  * @svr: system version (content of platform SVR register)
  71  * @pvr: processor version (content of platform PVR register)
  72  */
  73 struct mc_soc_version {
  74         uint32_t svr;
  75         uint32_t pvr;
  76 };
  77
  78 /**
  79  * mc_get_version() - Retrieves the Management Complex firmware
  80  *                      version information
  81  * @mc_io:              Pointer to opaque I/O object
  82  * @cmd_flags:  Command flags; one or more of 'MC_CMD_FLAG_'
  83  * @mc_ver_info:        Returned version information structure
  84  *
  85  * Return:      '0' on Success; Error code otherwise.
  86  */
  87 int mc_get_version(struct fsl_mc_io     *mc_io,
  88                    uint32_t             cmd_flags,
  89                    struct mc_version    *mc_ver_info);
  90
  91 /**
  92  * mc_get_soc_version() - Retrieves the Management Complex firmware
  93  *                      version information
  94  * @mc_io:              Pointer to opaque I/O object
  95  * @cmd_flags:  Command flags; one or more of 'MC_CMD_FLAG_'
  96  * @mc_platform_info:   Returned version information structure. The structure
  97  * contains the values of SVR and PVR registers. Please consult platform
  98  * specific reference manual for detailed information.
  99  *
 100  * Return:      '0' on Success; Error code otherwise.
 101  */
 102 int mc_get_soc_version(struct fsl_mc_io *mc_io,
 103                        uint32_t cmd_flags,
 104                        struct mc_soc_version *mc_platform_info);
 105
 106 #endif /* __FSL_DPMNG_H */