nv-tegra-mirror/linux-nvgpu
1
0
Fork 0
mirror of git://nv-tegra.nvidia.com/linux-nvgpu.git synced 2025-12-24 02:22:34 +03:00
Code Issues Packages Projects Releases Wiki Activity

gpu: nvgpu: netlist: add doxygen for netlist.h

Browse Source 
Added doxygen documentation for netlist public functions and data
structures.

Moved struct ctxsw_buf_offset_map_entry to correct location from
netlist.h to gr/hwpm_map.h.

JIRA NVGPU-3929

Change-Id: Ibefd89475bcf59d01cfad83a1e702e10d70a0de1
Signed-off-by: Seshendra Gadagottu <sgadagottu@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/2216186
Reviewed-by: svc-mobile-coverity <svc-mobile-coverity@nvidia.com>
Reviewed-by: svc-mobile-misra <svc-mobile-misra@nvidia.com>
Reviewed-by: Automatic_Commit_Validation_User
GVS: Gerrit_Virtual_Submit
Reviewed-by: Vinod Gopalakrishnakurup <vinodg@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
This commit is contained in:
Seshendra Gadagottu
2019-10-11 16:00:31 -07:00
committed by Alex Waterman
parent 3e26a25e36
commit 6663a1feaf
3 changed files with 278 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
drivers/gpu/nvgpu/common/netlist/netlist.c
View File

@@ -56,11 +56,11 @@ struct netlist_av *nvgpu_netlist_alloc_av_list(struct gk20a *g,
}
struct netlist_av64 *nvgpu_netlist_alloc_av64_list(struct gk20a *g,
struct netlist_av64_list *avl)
struct netlist_av64_list *av64l)
{
avl->l = nvgpu_kzalloc(g, nvgpu_safe_mult_u64(avl->count,
sizeof(*avl->l)));
return avl->l;
av64l->l = nvgpu_kzalloc(g, nvgpu_safe_mult_u64(av64l->count,
sizeof(*av64l->l)));
return av64l->l;
}
struct netlist_aiv *nvgpu_netlist_alloc_aiv_list(struct gk20a *g,

5
drivers/gpu/nvgpu/include/nvgpu/gr/hwpm_map.h
View File

@@ -31,6 +31,11 @@ struct gk20a;
struct ctxsw_buf_offset_map_entry;
struct nvgpu_gr_config;
struct ctxsw_buf_offset_map_entry {
u32 addr; /* Register address */
u32 offset; /* Offset in ctxt switch buffer */
};
struct nvgpu_gr_hwpm_map {
u32 pm_ctxsw_image_size;

283
drivers/gpu/nvgpu/include/nvgpu/netlist.h
View File

@@ -21,78 +21,332 @@
*/
#ifndef NVGPU_NETLIST_H
#define NVGPU_NETLIST_H
/**
* @file
*
* common.netlist unit interface
*/
#include <nvgpu/types.h>
struct gk20a;
/**
* Description of netlist Address-Value(av) structure.
*/
struct netlist_av {
/** U32 address in av structure. */
u32 addr;
/** U32 value in av structure. */
u32 value;
};
/**
* Description of netlist Address-Value64(av64) structure.
*/
struct netlist_av64 {
/** U32 address in av64 structure. */
u32 addr;
/** Lower u32 value in av64 structure. */
u32 value_lo;
/** Higher u32 value in av64 structure. */
u32 value_hi;
};
/**
* Description of netlist Address-Index-Value(aiv) structure.
*/
struct netlist_aiv {
/** U32 address in aiv structure. */
u32 addr;
/** U32 index in aiv structure. */
u32 index;
/** U32 value in aiv structure. */
u32 value;
};
/**
* Description of netlist aiv list bundle structure.
*/
struct netlist_aiv_list {
/** Pointer to netlist aiv bundle. */
struct netlist_aiv *l;
/** Number of netlist aiv bundles. */
u32 count;
};
/**
* Description of netlist av list bundle structure.
*/
struct netlist_av_list {
/** Pointer to netlist av bundle. */
struct netlist_av *l;
/** Number of netlist av bundles. */
u32 count;
};
/**
* Description of netlist av64 list bundle structure.
*/
struct netlist_av64_list {
/** Pointer to netlist av64 bundle. */
struct netlist_av64 *l;
/** Number of netlist av64 bundles. */
u32 count;
};
/**
* Description of netlist u32 list bundle structure.
*/
struct netlist_u32_list {
/** Pointer to u32 value. */
u32 *l;
/** Number of u32 elements in the list. */
u32 count;
};
struct ctxsw_buf_offset_map_entry {
u32 addr; /* Register address */
u32 offset; /* Offset in ctxt switch buffer */
};
struct netlist_av *nvgpu_netlist_alloc_av_list(struct gk20a *g, struct netlist_av_list *avl);
struct netlist_av64 *nvgpu_netlist_alloc_av64_list(struct gk20a *g, struct netlist_av64_list *avl);
struct netlist_aiv *nvgpu_netlist_alloc_aiv_list(struct gk20a *g, struct netlist_aiv_list *aivl);
u32 *nvgpu_netlist_alloc_u32_list(struct gk20a *g, struct netlist_u32_list *u32l);
/**
* @brief Allocates memory for netlist bundles and populates
* ctxsw region info from ctxsw firmware file.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function allocates memory for netlist unit variables and bundles.
* Opens netlist ctxsw firmware file based on firmware definition and loads
* different bundles into appropriate netlist regions structures.
*
* @return 0 in case of success, < 0 in case of failure.
* @retval -ENOMEM if memory allocation for netlist variables or bundle fails.
* @retval -ENOENT if it fails to find required netlist firmware file.
* @retval -ENOENT if netlist s/w version mismatches with h/w config.
*/
int nvgpu_netlist_init_ctx_vars(struct gk20a *g);
/**
* @brief Frees memory allocated for netlist bundles.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function frees all allocated memory for netlist bundles and
* netlist vars.
*/
void nvgpu_netlist_deinit_ctx_vars(struct gk20a *g);
/**
* @brief Allocates memory for netlist av list bundle.
*
* @param g [in] Pointer to GPU driver struct.
* @param avl [in] Pointer to #netlist_av_list struct.
*
* This function allocates memory for netlist av list bundles for the
* requested size from #netlist_av_list count.
*
* @return Pointer to #netlist_av.
* @retval NULL if memory allocation for #netlist_av bundles fails.
*/
struct netlist_av *nvgpu_netlist_alloc_av_list(struct gk20a *g,
struct netlist_av_list *avl);
/**
* @brief Allocates memory for netlist av64 list bundle.
*
* @param g [in] Pointer to GPU driver struct.
* @param av64l [in] Pointer to #netlist_av64_list struct.
*
* This function allocates memory for netlist av64 list bundles for the
* requested size from #netlist_av64_list count.
*
* @return Pointer to #netlist_av64 struct.
* @retval NULL if memory allocation for #netlist_av64 bundles fails.
*/
struct netlist_av64 *nvgpu_netlist_alloc_av64_list(struct gk20a *g,
struct netlist_av64_list *av64l);
/**
* @brief Allocates memory for netlist aiv list bundle.
*
* @param g [in] Pointer to GPU driver struct.
* @param aivl [in] Pointer to #netlist_avi_list struct.
*
* This function allocates memory for netlist aiv list bundles for the
* requested size from #netlist_aiv_list count.
*
* @return Pointer to #netlist_aiv struct.
* @retval NULL if memory allocation for #netlist_aiv bundles fails.
*/
struct netlist_aiv *nvgpu_netlist_alloc_aiv_list(struct gk20a *g,
struct netlist_aiv_list *aivl);
/**
* @brief Allocates memory for netlist u32 list bundle.
*
* @param g [in] Pointer to GPU driver struct.
* @param u32l [in] Pointer to #netlist_u32_list struct.
*
* This function allocates memory for netlist u32 list bundles for the
* requested size from #netlist_u32_list count.
*
* @return Pointer to u32 list.
* @retval NULL if memory allocation for u32 list bundles fails.
*/
u32 *nvgpu_netlist_alloc_u32_list(struct gk20a *g,
struct netlist_u32_list *u32l);
/**
* @brief Get s/w non-context #netlist_av_list bundles from firmware.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function returns non-context #netlist_av_list bundles from
* netlist firmware. SW needs to program these bundles to h/w as part
* of golden context creation.
*
* @return Pointer to #netlist_av_list struct.
*/
struct netlist_av_list *nvgpu_netlist_get_sw_non_ctx_load_av_list(
struct gk20a *g);
/**
* @brief Get s/w context #netlist_aiv_list bundles from firmware.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function returns s/w context #netlist_aiv_list bundles from
* netlist firmware. SW needs to program these bundles to h/w as part
* of golden context creation.
*
* @return Pointer to #netlist_aiv_list struct.
*/
struct netlist_aiv_list *nvgpu_netlist_get_sw_ctx_load_aiv_list(
struct gk20a *g);
/**
* @brief Get s/w method init #netlist_av_list bundles from firmware.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function returns s/w method init #netlist_av_list bundles from
* netlist firmware. SW needs to program these bundles to h/w as part
* of golden context creation.
*
* @return Pointer to #netlist_av_list struct.
*/
struct netlist_av_list *nvgpu_netlist_get_sw_method_init_av_list(
struct gk20a *g);
/**
* @brief Get s/w init #netlist_av_list bundles from firmware.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function returns s/w bundles #netlist_av_list bundles from
* netlist firmware. SW needs to program these bundles to h/w as part
* of golden context creation.
*
* @return Pointer to #netlist_av_list struct.
*/
struct netlist_av_list *nvgpu_netlist_get_sw_bundle_init_av_list(
struct gk20a *g);
/**
* @brief Get s/w veid init #netlist_av_list bundles from firmware.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function returns s/w veid #netlist_av_list bundles from
* netlist firmware. SW needs to program these bundles to h/w as part
* of golden context creation.
*
* @return Pointer to #netlist_av_list struct.
*/
struct netlist_av_list *nvgpu_netlist_get_sw_veid_bundle_init_av_list(
struct gk20a *g);
/**
* @brief Get s/w u64 init #netlist_av64_list bundles from firmware.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function returns s/w u64 #netlist_av64_list bundles from
* netlist firmware. SW needs to program these bundles to h/w as part
* of golden context creation.
*
* @return Pointer to #netlist_av64_list struct.
*/
struct netlist_av64_list *nvgpu_netlist_get_sw_bundle64_init_av64_list(
struct gk20a *g);
/**
* @brief Get FECS imem ucode size from firmware.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function returns h/w fecs imem ucode size from netlist firmware.
* SW needs this information for falcon FECS ucode programming.
*
* @return FECS imem ucode size.
*/
u32 nvgpu_netlist_get_fecs_inst_count(struct gk20a *g);
/**
* @brief Get FECS dmem ucode size from firmware.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function returns h/w fecs dmem ucode size from netlist firmware.
* SW needs this information for falcon FECS ucode programming.
*
* @return FECS dmem ucode size.
*/
u32 nvgpu_netlist_get_fecs_data_count(struct gk20a *g);
/**
* @brief Get GPCCS imem ucode size from firmware.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function returns h/w gpccs imem ucode size from netlist firmware.
* SW needs this information for falcon GPCCS ucode programming.
*
* @return GPCCS imem ucode size.
*/
u32 nvgpu_netlist_get_gpccs_inst_count(struct gk20a *g);
/**
* @brief Get GPCCS dmem ucode size from firmware.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function returns h/w gpccs dmem ucode size from netlist firmware.
* SW needs this information for falcon GPCCS ucode programming.
*
* @return GPCCS dmem ucode size.
*/
u32 nvgpu_netlist_get_gpccs_data_count(struct gk20a *g);
/**
* @brief Get pointer to FECS imem ucode from firmware.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function returns pointer to fecs imem ucode from netlist firmware.
* SW will use this information for falcon FECS imem ucode programming.
*
* @return U32 pointer to FECS imem ucode.
*/
u32 *nvgpu_netlist_get_fecs_inst_list(struct gk20a *g);
/**
* @brief Get pointer to FECS dmem ucode from firmware.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function returns pointer to fecs dmem ucode from netlist firmware.
* SW will use this information for falcon FECS ucode programming.
*
* @return U32 pointer to FECS dmem ucode.
*/
u32 *nvgpu_netlist_get_fecs_data_list(struct gk20a *g);
/**
* @brief Get pointer Io GPCCS imem ucode from firmware.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function returns pointer to gpccs imem ucode from netlist firmware.
* SW will use this information for falcon GPCCS ucode programming.
*
* @return U32 pointer to GPCCS imem ucode.
*/
u32 *nvgpu_netlist_get_gpccs_inst_list(struct gk20a *g);
/**
* @brief Get pointer to GPCCS dmem ucode from firmware.
*
* @param g [in] Pointer to GPU driver struct.
*
* This function returns pointer to gpccs dmem ucode from netlist firmware.
* SW will use this information for falcon GPCCS ucode programming.
*
* @return U32 pointer to GPCCS dmem ucode.
*/
u32 *nvgpu_netlist_get_gpccs_data_list(struct gk20a *g);
/** @cond DOXYGEN_SHOULD_SKIP_THIS */
#ifdef CONFIG_NVGPU_DEBUGGER
struct netlist_aiv_list *nvgpu_netlist_get_sys_ctxsw_regs(struct gk20a *g);
struct netlist_aiv_list *nvgpu_netlist_get_gpc_ctxsw_regs(struct gk20a *g);
@@ -139,5 +393,6 @@ void nvgpu_netlist_vars_set_dynamic(struct gk20a *g, bool set);
void nvgpu_netlist_vars_set_buffer_size(struct gk20a *g, u32 size);
void nvgpu_netlist_vars_set_regs_base_index(struct gk20a *g, u32 index);
#endif
/** @endcond DOXYGEN_SHOULD_SKIP_THIS */
#endif /* NVGPU_NETLIST_H */