/*
 * Copyright (c) 2012-2019, NVIDIA CORPORATION.  All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * 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, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * 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.
 */
/*
 * Function/Macro naming determines intended use:
 *
 *     <x>_r(void) : Returns the offset for register <x>.
 *
 *     <x>_o(void) : Returns the offset for element <x>.
 *
 *     <x>_w(void) : Returns the word offset for word (4 byte) element <x>.
 *
 *     <x>_<y>_s(void) : Returns size of field <y> of register <x> in bits.
 *
 *     <x>_<y>_f(u32 v) : Returns a value based on 'v' which has been shifted
 *         and masked to place it at field <y> of register <x>.  This value
 *         can be |'d with others to produce a full register value for
 *         register <x>.
 *
 *     <x>_<y>_m(void) : Returns a mask for field <y> of register <x>.  This
 *         value can be ~'d and then &'d to clear the value of field <y> for
 *         register <x>.
 *
 *     <x>_<y>_<z>_f(void) : Returns the constant value <z> after being shifted
 *         to place it at field <y> of register <x>.  This value can be |'d
 *         with others to produce a full register value for <x>.
 *
 *     <x>_<y>_v(u32 r) : Returns the value of field <y> from a full register
 *         <x> value 'r' after being shifted to place its LSB at bit 0.
 *         This value is suitable for direct comparison with other unshifted
 *         values appropriate for use in field <y> of register <x>.
 *
 *     <x>_<y>_<z>_v(void) : Returns the constant value for <z> defined for
 *         field <y> of register <x>.  This value is suitable for direct
 *         comparison with unshifted values appropriate for use in field <y>
 *         of register <x>.
 */
#ifndef NVGPU_HW_PRI_RINGMASTER_GK20A_H
#define NVGPU_HW_PRI_RINGMASTER_GK20A_H

#include <nvgpu/types.h>
#include <nvgpu/static_analysis.h>

#define pri_ringmaster_command_r()                                 (0x0012004cU)
#define pri_ringmaster_command_cmd_m()                        (U32(0x3fU) << 0U)
#define pri_ringmaster_command_cmd_v(r)                    (((r) >> 0U) & 0x3fU)
#define pri_ringmaster_command_cmd_no_cmd_v()                      (0x00000000U)
#define pri_ringmaster_command_cmd_start_ring_f()                         (0x1U)
#define pri_ringmaster_command_cmd_ack_interrupt_f()                      (0x2U)
#define pri_ringmaster_command_cmd_enumerate_stations_f()                 (0x3U)
#define pri_ringmaster_command_cmd_enumerate_stations_bc_grp_all_f()      (0x0U)
#define pri_ringmaster_command_data_r()                            (0x00120048U)
#define pri_ringmaster_start_results_r()                           (0x00120050U)
#define pri_ringmaster_start_results_connectivity_v(r)      (((r) >> 0U) & 0x1U)
#define pri_ringmaster_start_results_connectivity_pass_v()         (0x00000001U)
#define pri_ringmaster_intr_status0_r()                            (0x00120058U)
#define pri_ringmaster_intr_status0_ring_start_conn_fault_v(r)\
				(((r) >> 0U) & 0x1U)
#define pri_ringmaster_intr_status0_disconnect_fault_v(r)   (((r) >> 1U) & 0x1U)
#define pri_ringmaster_intr_status0_overflow_fault_v(r)     (((r) >> 2U) & 0x1U)
#define pri_ringmaster_intr_status0_gbl_write_error_sys_v(r)\
				(((r) >> 8U) & 0x1U)
#define pri_ringmaster_intr_status1_r()                            (0x0012005cU)
#define pri_ringmaster_global_ctl_r()                              (0x00120060U)
#define pri_ringmaster_global_ctl_ring_reset_asserted_f()                 (0x1U)
#define pri_ringmaster_global_ctl_ring_reset_deasserted_f()               (0x0U)
#define pri_ringmaster_enum_fbp_r()                                (0x00120074U)
#define pri_ringmaster_enum_fbp_count_v(r)                 (((r) >> 0U) & 0x1fU)
#define pri_ringmaster_enum_gpc_r()                                (0x00120078U)
#define pri_ringmaster_enum_gpc_count_v(r)                 (((r) >> 0U) & 0x1fU)
#endif
