diff options
author | Martin Roth <gaumless@gmail.com> | 2015-01-06 10:27:39 -0700 |
---|---|---|
committer | Martin Roth <gaumless@gmail.com> | 2015-01-08 21:58:45 +0100 |
commit | f4cb4128adea4b8ebdd92ae05d7d8e733e35eb1c (patch) | |
tree | e9a9e47a8fdb993524baaae872e8edc93a0cf135 /src/northbridge/amd/amdht/h3finit.c | |
parent | aa3dd5d5db2bb3a9825a3c5104f28699f7b43f87 (diff) | |
download | coreboot-f4cb4128adea4b8ebdd92ae05d7d8e733e35eb1c.tar.xz |
northbridge/amd: Doxygen fixes
- Add missing parameter names in several files
- remove parameter types in several files
- remove lines from doxygen documentation. These should be outside the
doxygen comments.
- Some of the comments shouldn't have been doxygen style. Turn these
into regular non-doxygen comments.
Change-Id: Ieccfe237385efee007b48308d58eb0a6a12f5bfa
Signed-off-by: Martin Roth <gaumless@gmail.com>
Reviewed-on: http://review.coreboot.org/8153
Tested-by: build bot (Jenkins)
Reviewed-by: Edward O'Callaghan <eocallaghan@alterapraxis.com>
Diffstat (limited to 'src/northbridge/amd/amdht/h3finit.c')
-rw-r--r-- | src/northbridge/amd/amdht/h3finit.c | 44 |
1 files changed, 23 insertions, 21 deletions
diff --git a/src/northbridge/amd/amdht/h3finit.c b/src/northbridge/amd/amdht/h3finit.c index 764d2988b4..ff57033031 100644 --- a/src/northbridge/amd/amdht/h3finit.c +++ b/src/northbridge/amd/amdht/h3finit.c @@ -119,8 +119,8 @@ * Returns the number of nodes in the compressed graph * * Parameters: - * @param[in] u8 graph = a compressed graph - * @param[out] u8 results = the number of nodes in the graph + * @param[in] graph = a compressed graph + * @param[out] results = the number of nodes in the graph * --------------------------------------------------------------------------------------- */ static u8 graphHowManyNodes(u8 *graph) @@ -138,10 +138,10 @@ static u8 graphHowManyNodes(u8 *graph) * Relies on rule that directly connected nodes always route requests directly. * * Parameters: - * @param[in] u8 graph = the graph to examine - * @param[in] u8 nodeA = the node number of the first node - * @param[in] u8 nodeB = the node number of the second node - * @param[out] BOOL results = true if nodeA connects to nodeB false if not + * @param[in] graph = the graph to examine + * @param[in] nodeA = the node number of the first node + * @param[in] nodeB = the node number of the second node + * @param[out] results = true if nodeA connects to nodeB false if not * --------------------------------------------------------------------------------------- */ static BOOL graphIsAdjacent(u8 *graph, u8 nodeA, u8 nodeB) @@ -190,10 +190,10 @@ static u8 graphGetRsp(u8 *graph, u8 nodeA, u8 nodeB) * it is the responsibility of the caller to apply any permutation needed. * * Parameters: - * @param[in] u8 graph = the graph to examine - * @param[in] u8 nodeA = the node number of the first node - * @param[in] u8 nodeB = the node number of the second node - * @param[out] u8 results = The request route node + * @param[in] graph = the graph to examine + * @param[in] nodeA = the node number of the first node + * @param[in] nodeB = the node number of the second node + * @param[out] results = The request route node * --------------------------------------------------------------------------------------- */ static u8 graphGetReq(u8 *graph, u8 nodeA, u8 nodeB) @@ -213,10 +213,10 @@ static u8 graphGetReq(u8 *graph, u8 nodeA, u8 nodeB) * nodeB towards * * Parameters: - * @param[in] u8 graph = the graph to examine - * @param[in] u8 nodeA = the node number of the first node - * @param[in] u8 nodeB = the node number of the second node - * OU u8 results = the broadcast routes for nodeA from nodeB + * @param[in] graph = the graph to examine + * @param[in] nodeA = the node number of the first node + * @param[in] nodeB = the node number of the second node + * OU results = the broadcast routes for nodeA from nodeB * --------------------------------------------------------------------------------------- */ static u8 graphGetBc(u8 *graph, u8 nodeA, u8 nodeB) @@ -273,19 +273,21 @@ static void routeFromBSP(u8 targetNode, u8 actualTarget, sMainData *pDat) pDat->nb->writeRoutingTable(predecessorNode, actualTarget, predecessorLink, pDat->nb); } -/*---------------------------------------------------------------------------------------- - * u8 +/*---------------------------------------------------------------------------*/ + +/** + * u8 * convertNodeToLink(u8 srcNode, u8 targetNode, sMainData *pDat) * * Description: * Return the link on source node which connects to target node * * Parameters: - * @param[in] u8 srcNode = the source node - * @param[in] u8 targetNode = the target node to find the link to - * @param[in] sMainData* pDat = our global state - * @param[out] u8 results = the link on source which connects to target - * --------------------------------------------------------------------------------------- + * @param[in] srcNode = the source node + * @param[in] targetNode = the target node to find the link to + * @param[in] pDat = our global state + * @return the link on source which connects to target + * */ static u8 convertNodeToLink(u8 srcNode, u8 targetNode, sMainData *pDat) { |