Domovská stránka Prehľadávať Pomoc
Prihlásiť sa
SoftwareDesign
/
csu3_am335x
8
0
Fork 0
Súbory Issues 0 Pull requesty 0 Wiki
Branch: master
Branche Tagy
csu3_am335x
/
EVSE
/
GPL
/
tpm2-tss-3.2.0
/
doxygen-doc
/
html
/
group__ifapi__profile.html

group__ifapi__profile.html 14 KB
Permanentný odkaz História Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.13"/>
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
    8. 

  8. <title>tpm2-tss: Profile module</title>
    9. 

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
    13. 

  13. <script type="text/javascript" src="resize.js"></script>
    14. 

  14. <script type="text/javascript" src="navtreedata.js"></script>
    15. 

  15. <script type="text/javascript" src="navtree.js"></script>
    16. 

  16. <script type="text/javascript">
    17. 

  17.   $(document).ready(initResizable);
    18. 

  18. </script>
    19. 

  19. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    20. 

  20. </head>
    21. 

  21. <body>
    22. 

  22. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    23. 

  23. <div id="titlearea">
    24. 

  24. <table cellspacing="0" cellpadding="0">
    25. 

  25.  <tbody>
    26. 

  26.  <tr style="height: 56px;">
    27. 

  27.   <td id="projectalign" style="padding-left: 0.5em;">
    28. 

  28.    <div id="projectname">tpm2-tss
    29. 

  29.    &#160;<span id="projectnumber">3.2.0</span>
    30. 

  30.    </div>
    31. 

  31.    <div id="projectbrief">TPM Software stack 2.0 TCG spec compliant implementation</div>
    32. 

  32.   </td>
    33. 

  33.  </tr>
    34. 

  34.  </tbody>
    35. 

  35. </table>
    36. 

  36. </div>
    37. 

  37. <!-- end header part -->
    38. 

  38. <!-- Generated by Doxygen 1.8.13 -->
    39. 

  39. <script type="text/javascript" src="menudata.js"></script>
    40. 

  40. <script type="text/javascript" src="menu.js"></script>
    41. 

  41. <script type="text/javascript">
    42. 

  42. $(function() {
    43. 

  43.   initMenu('',false,false,'search.php','Search');
    44. 

  44. });
    45. 

  45. </script>
    46. 

  46. <div id="main-nav"></div>
    47. 

  47. </div><!-- top -->
    48. 

  48. <div id="side-nav" class="ui-resizable side-nav-resizable">
    49. 

  49.   <div id="nav-tree">
    50. 

  50.     <div id="nav-tree-contents">
    51. 

  51.       <div id="nav-sync" class="sync"></div>
    52. 

  52.     </div>
    53. 

  53.   </div>
    54. 

  54.   <div id="splitbar" style="-moz-user-select:none;" 
    55. 

  55.        class="ui-resizable-handle">
    56. 

  56.   </div>
    57. 

  57. </div>
    58. 

  58. <script type="text/javascript">
    59. 

  59. $(document).ready(function(){initNavTree('group__ifapi__profile.html','');});
    60. 

  60. </script>
    61. 

  61. <div id="doc-content">
    62. 

  62. <div class="header">
    63. 

  63.   <div class="summary">
    64. 

  64. <a href="#func-members">Functions</a>  </div>
    65. 

  65.   <div class="headertitle">
    66. 

  66. <div class="title">Profile module<div class="ingroups"><a class="el" href="group__fapi.html">Feature API</a> &raquo; <a class="el" href="group__ifapi.html">Internals of Feature API</a></div></div>  </div>
    67. 

  67. </div><!--header-->
    68. 

  68. <div class="contents">
    69. 

  69. <table class="memberdecls">
    70. 

  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    71. 

  71. Functions</h2></td></tr>
    72. 

  72. <tr class="memitem:ga7f35ab0d369df53118addf132afc9c6e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__profile.html#ga7f35ab0d369df53118addf132afc9c6e">ifapi_profiles_finalize</a> (<a class="el" href="struct_i_f_a_p_i___p_r_o_f_i_l_e_s.html">IFAPI_PROFILES</a> *profiles)</td></tr>
    73. 

  73. <tr class="separator:ga7f35ab0d369df53118addf132afc9c6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    74. 

  74. <tr class="memitem:ga1d1f66781412b41c312359da5808e743"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__profile.html#ga1d1f66781412b41c312359da5808e743">ifapi_profiles_get</a> (const <a class="el" href="struct_i_f_a_p_i___p_r_o_f_i_l_e_s.html">IFAPI_PROFILES</a> *profiles, const char *name, const <a class="el" href="struct_i_f_a_p_i___p_r_o_f_i_l_e.html">IFAPI_PROFILE</a> **profile)</td></tr>
    75. 

  75. <tr class="separator:ga1d1f66781412b41c312359da5808e743"><td class="memSeparator" colspan="2">&#160;</td></tr>
    76. 

  76. <tr class="memitem:ga726700f428528de3917ffaa1e7bbf429"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__profile.html#ga726700f428528de3917ffaa1e7bbf429">ifapi_profiles_initialize_async</a> (<a class="el" href="struct_i_f_a_p_i___p_r_o_f_i_l_e_s.html">IFAPI_PROFILES</a> *profiles, <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, const char *profilesdir, const char *defaultprofile)</td></tr>
    77. 

  77. <tr class="separator:ga726700f428528de3917ffaa1e7bbf429"><td class="memSeparator" colspan="2">&#160;</td></tr>
    78. 

  78. <tr class="memitem:ga48f2955d99163ee98cb37fbe423c5c3d"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__profile.html#ga48f2955d99163ee98cb37fbe423c5c3d">ifapi_profiles_initialize_finish</a> (<a class="el" href="struct_i_f_a_p_i___p_r_o_f_i_l_e_s.html">IFAPI_PROFILES</a> *profiles, <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io)</td></tr>
    79. 

  79. <tr class="separator:ga48f2955d99163ee98cb37fbe423c5c3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
    80. 

  80. </table>
    81. 

  81. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    82. 

  82. <p>Provides functions for the handling of profiles stored in the object store. </p>
    83. 

  83. <h2 class="groupheader">Function Documentation</h2>
    84. 

  84. <a id="ga7f35ab0d369df53118addf132afc9c6e"></a>
    85. 

  85. <h2 class="memtitle"><span class="permalink"><a href="#ga7f35ab0d369df53118addf132afc9c6e">&#9670;&nbsp;</a></span>ifapi_profiles_finalize()</h2>
    86. 

  86. 

  87. <div class="memitem">
    88. 

  88. <div class="memproto">
    89. 

  89.       <table class="memname">
    90. 

  90.         <tr>
    91. 

  91.           <td class="memname">void ifapi_profiles_finalize </td>
    92. 

  92.           <td>(</td>
    93. 

  93.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___p_r_o_f_i_l_e_s.html">IFAPI_PROFILES</a> *&#160;</td>
    94. 

  94.           <td class="paramname"><em>profiles</em></td><td>)</td>
    95. 

  95.           <td></td>
    96. 

  96.         </tr>
    97. 

  97.       </table>
    98. 

  98. </div><div class="memdoc">
    99. 

  99. <p>Sanitizes and frees internal data structures of loaded profiles' information.</p>
    100. 

  100. <dl class="params"><dt>Parameters</dt><dd>
    101. 

  101.   <table class="params">
    102. 

  102.     <tr><td class="paramdir">[in,out]</td><td class="paramname">profiles</td><td>The context for the profiles information. </td></tr>
    103. 

  103.   </table>
    104. 

  104.   </dd>
    105. 

  105. </dl>
    106. 

  106. 

  107. </div>
    108. 

  108. </div>
    109. 

  109. <a id="ga1d1f66781412b41c312359da5808e743"></a>
    110. 

  110. <h2 class="memtitle"><span class="permalink"><a href="#ga1d1f66781412b41c312359da5808e743">&#9670;&nbsp;</a></span>ifapi_profiles_get()</h2>
    111. 

  111. 

  112. <div class="memitem">
    113. 

  113. <div class="memproto">
    114. 

  114.       <table class="memname">
    115. 

  115.         <tr>
    116. 

  116.           <td class="memname">TSS2_RC ifapi_profiles_get </td>
    117. 

  117.           <td>(</td>
    118. 

  118.           <td class="paramtype">const <a class="el" href="struct_i_f_a_p_i___p_r_o_f_i_l_e_s.html">IFAPI_PROFILES</a> *&#160;</td>
    119. 

  119.           <td class="paramname"><em>profiles</em>, </td>
    120. 

  120.         </tr>
    121. 

  121.         <tr>
    122. 

  122.           <td class="paramkey"></td>
    123. 

  123.           <td></td>
    124. 

  124.           <td class="paramtype">const char *&#160;</td>
    125. 

  125.           <td class="paramname"><em>name</em>, </td>
    126. 

  126.         </tr>
    127. 

  127.         <tr>
    128. 

  128.           <td class="paramkey"></td>
    129. 

  129.           <td></td>
    130. 

  130.           <td class="paramtype">const <a class="el" href="struct_i_f_a_p_i___p_r_o_f_i_l_e.html">IFAPI_PROFILE</a> **&#160;</td>
    131. 

  131.           <td class="paramname"><em>profile</em>&#160;</td>
    132. 

  132.         </tr>
    133. 

  133.         <tr>
    134. 

  134.           <td></td>
    135. 

  135.           <td>)</td>
    136. 

  136.           <td></td><td></td>
    137. 

  137.         </tr>
    138. 

  138.       </table>
    139. 

  139. </div><div class="memdoc">
    140. 

  140. <p>Return the profile data for a given profile name.</p>
    141. 

  141. <p>Returns a (const, not to be free'd) pointer to the profile data for a requested profile. If a NULL profile is requesten, then the default profile is returned. If a keypath is passed in, then the prefix is analysed. If that keypath starts with a profile then this profile is returned. Otherwise the default profile is returned.</p>
    142. 

  142. <dl class="params"><dt>Parameters</dt><dd>
    143. 

  143.   <table class="params">
    144. 

  144.     <tr><td class="paramdir">[in]</td><td class="paramname">profiles</td><td>The profiles context </td></tr>
    145. 

  145.     <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the profile or the keypath </td></tr>
    146. 

  146.     <tr><td class="paramdir">[out]</td><td class="paramname">profile</td><td>The pointer to the profile data. </td></tr>
    147. 

  147.   </table>
    148. 

  148.   </dd>
    149. 

  149. </dl>
    150. 

  150. <dl class="retval"><dt>Return values</dt><dd>
    151. 

  151.   <table class="retval">
    152. 

  152.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    153. 

  153.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if NULL pointers were passed in. </td></tr>
    154. 

  154.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if a profile is not found. </td></tr>
    155. 

  155.   </table>
    156. 

  156.   </dd>
    157. 

  157. </dl>
    158. 

  158. 

  159. </div>
    160. 

  160. </div>
    161. 

  161. <a id="ga726700f428528de3917ffaa1e7bbf429"></a>
    162. 

  162. <h2 class="memtitle"><span class="permalink"><a href="#ga726700f428528de3917ffaa1e7bbf429">&#9670;&nbsp;</a></span>ifapi_profiles_initialize_async()</h2>
    163. 

  163. 

  164. <div class="memitem">
    165. 

  165. <div class="memproto">
    166. 

  166.       <table class="memname">
    167. 

  167.         <tr>
    168. 

  168.           <td class="memname">TSS2_RC ifapi_profiles_initialize_async </td>
    169. 

  169.           <td>(</td>
    170. 

  170.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___p_r_o_f_i_l_e_s.html">IFAPI_PROFILES</a> *&#160;</td>
    171. 

  171.           <td class="paramname"><em>profiles</em>, </td>
    172. 

  172.         </tr>
    173. 

  173.         <tr>
    174. 

  174.           <td class="paramkey"></td>
    175. 

  175.           <td></td>
    176. 

  176.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
    177. 

  177.           <td class="paramname"><em>io</em>, </td>
    178. 

  178.         </tr>
    179. 

  179.         <tr>
    180. 

  180.           <td class="paramkey"></td>
    181. 

  181.           <td></td>
    182. 

  182.           <td class="paramtype">const char *&#160;</td>
    183. 

  183.           <td class="paramname"><em>profilesdir</em>, </td>
    184. 

  184.         </tr>
    185. 

  185.         <tr>
    186. 

  186.           <td class="paramkey"></td>
    187. 

  187.           <td></td>
    188. 

  188.           <td class="paramtype">const char *&#160;</td>
    189. 

  189.           <td class="paramname"><em>defaultprofile</em>&#160;</td>
    190. 

  190.         </tr>
    191. 

  191.         <tr>
    192. 

  192.           <td></td>
    193. 

  193.           <td>)</td>
    194. 

  194.           <td></td><td></td>
    195. 

  195.         </tr>
    196. 

  196.       </table>
    197. 

  197. </div><div class="memdoc">
    198. 

  198. <p>Initialize the profiles information in the context in an asynchronous way</p>
    199. 

  199. <p>Load the profile information from disk, fill the dictionary of loaded profiles and fill the default profile information into the context.</p>
    200. 

  200. <p>Call ifapi_profiles_initialize_finish to complete the operation.</p>
    201. 

  201. <dl class="params"><dt>Parameters</dt><dd>
    202. 

  202.   <table class="params">
    203. 

  203.     <tr><td class="paramdir">[in,out]</td><td class="paramname">profiles</td><td>The context for the profiles information. </td></tr>
    204. 

  204.     <tr><td class="paramdir">[in,out]</td><td class="paramname">io</td><td>The input/output context being used for file I/O. </td></tr>
    205. 

  205.     <tr><td class="paramdir">[in]</td><td class="paramname">profilesdir</td><td>The directory to load profile information from. </td></tr>
    206. 

  206.     <tr><td class="paramdir">[in]</td><td class="paramname">defaultprofile</td><td>The name of the default profile to use. </td></tr>
    207. 

  207.   </table>
    208. 

  208.   </dd>
    209. 

  209. </dl>
    210. 

  210. <dl class="retval"><dt>Return values</dt><dd>
    211. 

  211.   <table class="retval">
    212. 

  212.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    213. 

  213.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if NULL pointers were passed in. </td></tr>
    214. 

  214.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if the profilesdir does not exist or is empty. </td></tr>
    215. 

  215.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if creation of log_dir failed or log_dir is not writable. </td></tr>
    216. 

  216.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory allocation failed. </td></tr>
    217. 

  217.   </table>
    218. 

  218.   </dd>
    219. 

  219. </dl>
    220. 

  220. 

  221. </div>
    222. 

  222. </div>
    223. 

  223. <a id="ga48f2955d99163ee98cb37fbe423c5c3d"></a>
    224. 

  224. <h2 class="memtitle"><span class="permalink"><a href="#ga48f2955d99163ee98cb37fbe423c5c3d">&#9670;&nbsp;</a></span>ifapi_profiles_initialize_finish()</h2>
    225. 

  225. 

  226. <div class="memitem">
    227. 

  227. <div class="memproto">
    228. 

  228.       <table class="memname">
    229. 

  229.         <tr>
    230. 

  230.           <td class="memname">TSS2_RC ifapi_profiles_initialize_finish </td>
    231. 

  231.           <td>(</td>
    232. 

  232.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___p_r_o_f_i_l_e_s.html">IFAPI_PROFILES</a> *&#160;</td>
    233. 

  233.           <td class="paramname"><em>profiles</em>, </td>
    234. 

  234.         </tr>
    235. 

  235.         <tr>
    236. 

  236.           <td class="paramkey"></td>
    237. 

  237.           <td></td>
    238. 

  238.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
    239. 

  239.           <td class="paramname"><em>io</em>&#160;</td>
    240. 

  240.         </tr>
    241. 

  241.         <tr>
    242. 

  242.           <td></td>
    243. 

  243.           <td>)</td>
    244. 

  244.           <td></td><td></td>
    245. 

  245.         </tr>
    246. 

  246.       </table>
    247. 

  247. </div><div class="memdoc">
    248. 

  248. <p>Initialize the profiles information in the context in an asynchronous way</p>
    249. 

  249. <p>Call after ifapi_profiles_initialize_async to complete the operation.</p>
    250. 

  250. <dl class="params"><dt>Parameters</dt><dd>
    251. 

  251.   <table class="params">
    252. 

  252.     <tr><td class="paramdir">[in,out]</td><td class="paramname">profiles</td><td>The context for the profiles information. </td></tr>
    253. 

  253.     <tr><td class="paramdir">[in,out]</td><td class="paramname">io</td><td>The input/output context being used for file I/O. </td></tr>
    254. 

  254.   </table>
    255. 

  255.   </dd>
    256. 

  256. </dl>
    257. 

  257. <dl class="retval"><dt>Return values</dt><dd>
    258. 

  258.   <table class="retval">
    259. 

  259.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    260. 

  260.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if NULL pointers were passed in. </td></tr>
    261. 

  261.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if a profile could not be loaded. </td></tr>
    262. 

  262.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if creation of log_dir failed or log_dir is not writable. </td></tr>
    263. 

  263.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory allocation failed. </td></tr>
    264. 

  264.     <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if the I/O operation is not finished yet and this function needs to be called again. </td></tr>
    265. 

  265.   </table>
    266. 

  266.   </dd>
    267. 

  267. </dl>
    268. 

  268. 

  269. </div>
    270. 

  270. </div>
    271. 

  271. </div><!-- contents -->
    272. 

  272. </div><!-- doc-content -->
    273. 

  273. <!-- start footer part -->
    274. 

  274. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    275. 

  275.   <ul>
    276. 

  276.     <li class="footer">Generated by
    277. 

  277.     <a href="http://www.doxygen.org/index.html">
    278. 

  278.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
    279. 

  279.   </ul>
    280. 

  280. </div>
    281. 

  281. </body>
    282. 

  282. </html>
    283.