Fábio Coutada
7855eab092
MAJOR MILESTONE: Successfully imported complete PikeOS 5.0 ecosystem from Virtual Machine 100 (devvm-arch) on gigabyte Proxmox server. Import Summary: - Source Code: 4.3GB, 63,441 files, 14,829 C/C++/H files - Documentation: 78MB, 37+ PDF manuals covering all PikeOS aspects - XSD Schemas: 1.8MB, 158 schema files for configuration/code generation - Test Framework: Complete TFW infrastructure in src/tfw/ Key Components: ✅ Multi-architecture kernels (ARM v7/v8, PowerPC e500/e500mc/e5500, x86_64) ✅ Core source libraries (libstand, ssw, p4ext) ✅ Complete test framework with executables, includes, libraries ✅ 37+ comprehensive PDF documentation (installation, development, platform manuals) ✅ 158 XSD schemas for Eclipse-based code generation and configuration ✅ AUTOSAR/MISRA safety-critical compliance foundation ✅ Hardware virtualization support ✅ Eclipse IDE project configuration (.project, .cproject) Documentation Categories: - Installation & User Guides (pikeos-installation-guide.pdf, user manuals) - Development References (kernel, driver, test framework manuals) - API & Programming (C/C++ environments, native API extensions) - Platform Manuals (ARM, PowerPC, x86 specific guides) - CDK Documentation (gcc, binutils, ld, cpp internals) - Release Notes (all components for 5.0.3) - Specialized Topics (hardware virtualization, POSIX compliance) Technical Achievements: ✅ Complete PikeOS 5.0 codebase across multiple processor architectures ✅ Safety-critical foundation with AUTOSAR/MISRA compliance ✅ Eclipse IDE integration with XSD-driven code generation pipeline ✅ Comprehensive test framework for validation and verification ✅ Complete documentation covering development, deployment, and optimization Extraction Method: - Source: VM 100 (devvm-arch) on gigabyte server (192.168.0.104) - Method: Direct LVM disk mount via losetup, rsync transfer - Size: Total 4.4GB extracted and organized Next Phases: - Phase 3: XSD Workflow Analysis (Day 8-10) - Phase 4: Safety Standards Compliance Documentation (Day 11-12) - Phase 5: Component Categorization (Day 13-14) - Phase 6: Aurelio Brain Test (Day 15) Co-Authored-By: Claude <noreply@anthropic.com>
103 lines
42 KiB
HTML
103 lines
42 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>driver_if.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('driver__if_8h_source.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">driver_if.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="driver__if_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -------------------------- FILE PROLOGUE -------------------------------- */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/**</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * @if INCLUDE_HEADER</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * @copyright</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * (C) Copyright SYSGO AG.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Ulm, Germany</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * @endif</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * @file</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * ddapi/driver_if.h</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * Device driver descriptor</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * @if INCLUDE_HEADER</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * @cfg_management</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * $Id: p4/ddapi/driver_if.h 2016-07-27 10:39:55 +0000 b5ef17f917bc1b72ca5005c3db885487dd6c6fe6 $</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * $Author$</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * $Date$</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * $Revision$</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * $State$</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * @endif</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> *</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> */</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifndef _DDAPI_DRIVER_IF_H_</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define _DDAPI_DRIVER_IF_H_</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">/* ------------------------- FILE INCLUSION -------------------------------- */</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <sys/types.h></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <sys/fs_file.h></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/**</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * @addtogroup DDAPI</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * @{</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> */</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">/**</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * Length of device driver name.</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> *</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> */</span></div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="group__DDAPI.html#ga6cbae856ad99aebcc118640eb18254c8"> 47</a></span> <span class="preprocessor">#define DRV_NAME_LEN 15</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">/**</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * Version number for struct devicemethods.</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> *</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> */</span></div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="group__DDAPI.html#ga3dd6e4773cc27e0af19ac2cfa929c749"> 55</a></span> <span class="preprocessor">#define DRIVER_IF_VERSION 2</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">/* Forward decl. */</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">struct </span>select_ctl;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">/** \n Type definition for device driver install method. */</span></div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="group__DDAPI.html#ga35dee27be8c7a59644c2761e082364de"> 61</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> *<a class="code" href="group__DDAPI.html#ga35dee27be8c7a59644c2761e082364de">drv_install_t</a>(<span class="keywordtype">void</span> *info);<span class="comment"></span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">/** \n Type definition for device driver uninstall method. */</span></div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="group__DDAPI.html#ga577f3996b285ac9ab4bfcec47923e6b7"> 63</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="group__DDAPI.html#ga577f3996b285ac9ab4bfcec47923e6b7">drv_uninstall_t</a>(<span class="keywordtype">void</span> *s);<span class="comment"></span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">/** \n Type definition for device driver open method. */</span></div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="group__DDAPI.html#ga9c09512fe6731f891bf9d2a0cf5672c2"> 65</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="group__DDAPI.html#ga9c09512fe6731f891bf9d2a0cf5672c2">drv_open_t</a>(<span class="keywordtype">void</span> *s, <span class="keyword">struct</span> _file *f, <span class="keywordtype">int</span> mode);<span class="comment"></span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">/** \n Type definition for device driver close method. */</span></div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="group__DDAPI.html#ga04c4202a1bc2548003cf33769e4d2ecf"> 67</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="group__DDAPI.html#ga04c4202a1bc2548003cf33769e4d2ecf">drv_close_t</a>(<span class="keywordtype">void</span> *s, <span class="keyword">struct</span> _file *f);<span class="comment"></span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">/** \n Type definition for device driver read method. */</span></div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="group__DDAPI.html#gabd6aa466339e82e8cb787fda24967ec2"> 69</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="group__DDAPI.html#gabd6aa466339e82e8cb787fda24967ec2">drv_read_t</a>(<span class="keywordtype">void</span> *s, <span class="keyword">struct</span> _file *f, <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> nbytes);<span class="comment"></span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">/** \n Type definition for device driver write method. */</span></div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="group__DDAPI.html#ga99acdea9a2d4bfedb026616056ea58ba"> 71</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="group__DDAPI.html#ga99acdea9a2d4bfedb026616056ea58ba">drv_write_t</a>(<span class="keywordtype">void</span> *s, <span class="keyword">struct</span> _file *f, <span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> nbytes);<span class="comment"></span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">/** \n Type definition for device driver ioctl method. */</span></div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="group__DDAPI.html#ga7d47df1f99c0f02dc1b493f61da28853"> 73</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="group__DDAPI.html#ga7d47df1f99c0f02dc1b493f61da28853">drv_ioctl_t</a>(<span class="keywordtype">void</span> *s, <span class="keyword">struct</span> _file *f, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> req, <span class="keywordtype">void</span> *argp);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#ifndef DOXYGEN</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">/** \n Type definition for device driver install method. */</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> drv_select_t(<span class="keywordtype">void</span> *s, <span class="keyword">struct</span> _file *f, <span class="keyword">struct</span> select_ctl *sel);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"></span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">/**</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * Device driver descriptor.</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> */</span></div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="structdevicemethods.html"> 83</a></span> <span class="keyword">struct </span><a class="code" href="structdevicemethods.html">devicemethods</a> {<span class="comment"></span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> /**</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * Device driver interface version number. Set to</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * DRIVER_IF_VERSION.</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> */</span></div><div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="structdevicemethods.html#a4753d991ee8cd51aa5923a8b5a3f825f"> 88</a></span>  <span class="keywordtype">unsigned</span> <a class="code" href="structdevicemethods.html#a4753d991ee8cd51aa5923a8b5a3f825f">version</a>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"></span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> /**</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * Device name. A string which identifies the device in the</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * file system. Used by the \e open function to choose the</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * device instance.</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> */</span></div><div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="structdevicemethods.html#aed0bafd3bbecf5433c0bf28a95c6bf93"> 95</a></span>  <span class="keywordtype">char</span> <a class="code" href="structdevicemethods.html#aed0bafd3bbecf5433c0bf28a95c6bf93">name</a>[<a class="code" href="group__DDAPI.html#ga6cbae856ad99aebcc118640eb18254c8">DRV_NAME_LEN</a> + 1];</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"></span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> /**</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * Device install entry point. Called once upon startup or as</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * a result of dd_install_driver(). Returns a pointer to</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * device statics upon success, else the NULL pointer.</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> */</span></div><div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="structdevicemethods.html#ab41a93b3c67304c5be3d2f8d97b07664"> 102</a></span>  <a class="code" href="group__DDAPI.html#ga35dee27be8c7a59644c2761e082364de">drv_install_t</a> *<a class="code" href="structdevicemethods.html#ab41a93b3c67304c5be3d2f8d97b07664">install</a>;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"></span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> /**</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * Device uninstall entry point. Called once during shutdown</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * or as a result of dd_deinstall_driver().</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> */</span></div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="structdevicemethods.html#a7da575f19684a38df480b3fc14b143f9"> 108</a></span>  <a class="code" href="group__DDAPI.html#ga577f3996b285ac9ab4bfcec47923e6b7">drv_uninstall_t</a> *<a class="code" href="structdevicemethods.html#a7da575f19684a38df480b3fc14b143f9">uninstall</a>;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor">#ifndef POSIX_CERT</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> /**</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * Device \e open entry point. Called in response to user</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * calling the \e open function on the device file. If the</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * user opens the device file several times, the \e open entry</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * point will be called for each time the device is opened. \n</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * May be NULL, the \e open function will always succeed if</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * so.</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> */</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> /**</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * Device \e open entry point. Called in response to user</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * calling the \e open function on the device file. If the</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * user opens the device file several times, the \e open entry</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * point will be called for each time the device is opened. \n</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> */</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="structdevicemethods.html#aa59ec215ef4ee4a6327c7bb0d3e70ab4"> 127</a></span>  <a class="code" href="group__DDAPI.html#ga9c09512fe6731f891bf9d2a0cf5672c2">drv_open_t</a> *<a class="code" href="structdevicemethods.html#aa59ec215ef4ee4a6327c7bb0d3e70ab4">open</a>;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor">#ifndef POSIX_CERT</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> /**</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * Device \a close entry point. Called in response to user</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * calling the \e close function on the last open file</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * descriptor for the device. \n</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * May be NULL.</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> */</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> /**</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * Device \a close entry point. Called in response to user</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * calling the \e close function on the last open file</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * descriptor for the device. \n</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> */</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="structdevicemethods.html#ac4cdc0add72acafaeec55010af4d7a0d"> 143</a></span>  <a class="code" href="group__DDAPI.html#ga04c4202a1bc2548003cf33769e4d2ecf">drv_close_t</a> *<a class="code" href="structdevicemethods.html#ac4cdc0add72acafaeec55010af4d7a0d">close</a>;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="preprocessor">#ifndef POSIX_CERT</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> /**</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * Device read entry point. Called in response to user calling</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * the \e read function on the file descriptor for the</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * device. \n</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * May be NULL, the \e read function will always return 0.</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> */</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> /**</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * Device read entry point. Called in response to user calling</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * the \e read function on the file descriptor for the</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * device. \n</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> */</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00159"></a><span class="lineno"><a class="line" href="structdevicemethods.html#a303a3310fbbddd13456c30d78a43f754"> 159</a></span>  <a class="code" href="group__DDAPI.html#gabd6aa466339e82e8cb787fda24967ec2">drv_read_t</a> *<a class="code" href="structdevicemethods.html#a303a3310fbbddd13456c30d78a43f754">read</a>;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="preprocessor">#ifndef POSIX_CERT</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> /**</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * Device read entry point. Called in response to user calling</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * the \e write function on the file descriptor for the</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * device. \n</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * May be NULL, the \e write function will always return 0.</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> */</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> /**</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * Device read entry point. Called in response to user calling</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * the \e write function on the file descriptor for the</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * device. \n</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> */</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00175"></a><span class="lineno"><a class="line" href="structdevicemethods.html#aef08e70c218f8a2759bcfbc93b356d8d"> 175</a></span>  <a class="code" href="group__DDAPI.html#ga99acdea9a2d4bfedb026616056ea58ba">drv_write_t</a> *<a class="code" href="structdevicemethods.html#aef08e70c218f8a2759bcfbc93b356d8d">write</a>;</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="preprocessor">#ifndef POSIX_CERT</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> /**</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * Device ctl entry point. Called in response to user calling</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * the \e ioctl function on the file descriptor for the</span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> * device. \n</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * May be NULL, the \e ioctl function will always return -1</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * and set \e errno to \c ENOTTY.</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> */</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> /**</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * Device ctl entry point. Called in response to user calling</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * the \e ioctl function on the file descriptor for the</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * device. \n</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> */</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00192"></a><span class="lineno"><a class="line" href="structdevicemethods.html#a70dccb2cb453c13d38c6b62502ab8fb9"> 192</a></span>  <a class="code" href="group__DDAPI.html#ga7d47df1f99c0f02dc1b493f61da28853">drv_ioctl_t</a> *<a class="code" href="structdevicemethods.html#a70dccb2cb453c13d38c6b62502ab8fb9">ctl</a>;</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"></span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> /**</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * Device poll entry point. Called in response to user calling</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * the \e poll or \e select functions on the file descriptor for</span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * the device. \n</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * Currently unused.</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> */</span></div><div class="line"><a name="l00200"></a><span class="lineno"><a class="line" href="structdevicemethods.html#aca593be94ebb8ca3d1111aac79305984"> 200</a></span>  drv_select_t *<a class="code" href="structdevicemethods.html#aca593be94ebb8ca3d1111aac79305984">select</a>;</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> };</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"></span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment">/** @} */</span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="preprocessor">#endif </span><span class="comment">/* !_DDAPI_DRIVER_IF_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="group__DDAPI_html_ga04c4202a1bc2548003cf33769e4d2ecf"><div class="ttname"><a href="group__DDAPI.html#ga04c4202a1bc2548003cf33769e4d2ecf">drv_close_t</a></div><div class="ttdeci">int drv_close_t(void *s, struct _file *f)</div><div class="ttdef"><b>Definition:</b> driver_if.h:67</div></div>
|
|
<div class="ttc" id="structdevicemethods_html_a70dccb2cb453c13d38c6b62502ab8fb9"><div class="ttname"><a href="structdevicemethods.html#a70dccb2cb453c13d38c6b62502ab8fb9">devicemethods::ctl</a></div><div class="ttdeci">drv_ioctl_t * ctl</div><div class="ttdef"><b>Definition:</b> driver_if.h:192</div></div>
|
|
<div class="ttc" id="structdevicemethods_html_ac4cdc0add72acafaeec55010af4d7a0d"><div class="ttname"><a href="structdevicemethods.html#ac4cdc0add72acafaeec55010af4d7a0d">devicemethods::close</a></div><div class="ttdeci">drv_close_t * close</div><div class="ttdef"><b>Definition:</b> driver_if.h:143</div></div>
|
|
<div class="ttc" id="structdevicemethods_html_a4753d991ee8cd51aa5923a8b5a3f825f"><div class="ttname"><a href="structdevicemethods.html#a4753d991ee8cd51aa5923a8b5a3f825f">devicemethods::version</a></div><div class="ttdeci">unsigned version</div><div class="ttdef"><b>Definition:</b> driver_if.h:88</div></div>
|
|
<div class="ttc" id="structdevicemethods_html_aca593be94ebb8ca3d1111aac79305984"><div class="ttname"><a href="structdevicemethods.html#aca593be94ebb8ca3d1111aac79305984">devicemethods::select</a></div><div class="ttdeci">drv_select_t * select</div><div class="ttdef"><b>Definition:</b> driver_if.h:200</div></div>
|
|
<div class="ttc" id="structdevicemethods_html_ab41a93b3c67304c5be3d2f8d97b07664"><div class="ttname"><a href="structdevicemethods.html#ab41a93b3c67304c5be3d2f8d97b07664">devicemethods::install</a></div><div class="ttdeci">drv_install_t * install</div><div class="ttdef"><b>Definition:</b> driver_if.h:102</div></div>
|
|
<div class="ttc" id="group__DDAPI_html_gabd6aa466339e82e8cb787fda24967ec2"><div class="ttname"><a href="group__DDAPI.html#gabd6aa466339e82e8cb787fda24967ec2">drv_read_t</a></div><div class="ttdeci">int drv_read_t(void *s, struct _file *f, void *buf, size_t nbytes)</div><div class="ttdef"><b>Definition:</b> driver_if.h:69</div></div>
|
|
<div class="ttc" id="structdevicemethods_html_aa59ec215ef4ee4a6327c7bb0d3e70ab4"><div class="ttname"><a href="structdevicemethods.html#aa59ec215ef4ee4a6327c7bb0d3e70ab4">devicemethods::open</a></div><div class="ttdeci">drv_open_t * open</div><div class="ttdef"><b>Definition:</b> driver_if.h:127</div></div>
|
|
<div class="ttc" id="group__DDAPI_html_ga9c09512fe6731f891bf9d2a0cf5672c2"><div class="ttname"><a href="group__DDAPI.html#ga9c09512fe6731f891bf9d2a0cf5672c2">drv_open_t</a></div><div class="ttdeci">int drv_open_t(void *s, struct _file *f, int mode)</div><div class="ttdef"><b>Definition:</b> driver_if.h:65</div></div>
|
|
<div class="ttc" id="group__DDAPI_html_ga35dee27be8c7a59644c2761e082364de"><div class="ttname"><a href="group__DDAPI.html#ga35dee27be8c7a59644c2761e082364de">drv_install_t</a></div><div class="ttdeci">void * drv_install_t(void *info)</div><div class="ttdef"><b>Definition:</b> driver_if.h:61</div></div>
|
|
<div class="ttc" id="structdevicemethods_html_aed0bafd3bbecf5433c0bf28a95c6bf93"><div class="ttname"><a href="structdevicemethods.html#aed0bafd3bbecf5433c0bf28a95c6bf93">devicemethods::name</a></div><div class="ttdeci">char name[DRV_NAME_LEN+1]</div><div class="ttdef"><b>Definition:</b> driver_if.h:95</div></div>
|
|
<div class="ttc" id="group__DDAPI_html_ga99acdea9a2d4bfedb026616056ea58ba"><div class="ttname"><a href="group__DDAPI.html#ga99acdea9a2d4bfedb026616056ea58ba">drv_write_t</a></div><div class="ttdeci">int drv_write_t(void *s, struct _file *f, const void *buf, size_t nbytes)</div><div class="ttdef"><b>Definition:</b> driver_if.h:71</div></div>
|
|
<div class="ttc" id="structdevicemethods_html"><div class="ttname"><a href="structdevicemethods.html">devicemethods</a></div><div class="ttdoc">Device driver descriptor. </div><div class="ttdef"><b>Definition:</b> driver_if.h:83</div></div>
|
|
<div class="ttc" id="group__DDAPI_html_ga6cbae856ad99aebcc118640eb18254c8"><div class="ttname"><a href="group__DDAPI.html#ga6cbae856ad99aebcc118640eb18254c8">DRV_NAME_LEN</a></div><div class="ttdeci">#define DRV_NAME_LEN</div><div class="ttdoc">Length of device driver name. </div><div class="ttdef"><b>Definition:</b> driver_if.h:47</div></div>
|
|
<div class="ttc" id="group__DDAPI_html_ga7d47df1f99c0f02dc1b493f61da28853"><div class="ttname"><a href="group__DDAPI.html#ga7d47df1f99c0f02dc1b493f61da28853">drv_ioctl_t</a></div><div class="ttdeci">int drv_ioctl_t(void *s, struct _file *f, unsigned long req, void *argp)</div><div class="ttdef"><b>Definition:</b> driver_if.h:73</div></div>
|
|
<div class="ttc" id="structdevicemethods_html_a7da575f19684a38df480b3fc14b143f9"><div class="ttname"><a href="structdevicemethods.html#a7da575f19684a38df480b3fc14b143f9">devicemethods::uninstall</a></div><div class="ttdeci">drv_uninstall_t * uninstall</div><div class="ttdef"><b>Definition:</b> driver_if.h:108</div></div>
|
|
<div class="ttc" id="group__DDAPI_html_ga577f3996b285ac9ab4bfcec47923e6b7"><div class="ttname"><a href="group__DDAPI.html#ga577f3996b285ac9ab4bfcec47923e6b7">drv_uninstall_t</a></div><div class="ttdeci">void drv_uninstall_t(void *s)</div><div class="ttdef"><b>Definition:</b> driver_if.h:63</div></div>
|
|
<div class="ttc" id="structdevicemethods_html_aef08e70c218f8a2759bcfbc93b356d8d"><div class="ttname"><a href="structdevicemethods.html#aef08e70c218f8a2759bcfbc93b356d8d">devicemethods::write</a></div><div class="ttdeci">drv_write_t * write</div><div class="ttdef"><b>Definition:</b> driver_if.h:175</div></div>
|
|
<div class="ttc" id="structdevicemethods_html_a303a3310fbbddd13456c30d78a43f754"><div class="ttname"><a href="structdevicemethods.html#a303a3310fbbddd13456c30d78a43f754">devicemethods::read</a></div><div class="ttdeci">drv_read_t * read</div><div class="ttdef"><b>Definition:</b> driver_if.h:159</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_a8adc0807d5a5926ebf6cd2ff2d915eb.html">localsrc</a></li><li class="navelem"><a class="el" href="dir_e5ab56458b395d3914abb489957af44a.html">pse51</a></li><li class="navelem"><a class="el" href="dir_382df6351c2622d26be84382bbf63b9d.html">p4</a></li><li class="navelem"><a class="el" href="dir_5334be65f3c481946a5f63c981ca1156.html">ddapi</a></li><li class="navelem"><a class="el" href="driver__if_8h.html">driver_if.h</a></li>
|
|
<li class="footer">(C) Copyright SYSGO AG</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|