Micro template library A library for building device drivers
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

classutl_1_1spi__bb__i.tex 5.8 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. \hypertarget{classutl_1_1spi__bb__i}{}\section{utl\+:\+:spi\+\_\+bb\+\_\+i$<$ impl\+\_\+t, C\+P\+OL, C\+P\+HA, Bit\+Order $>$ Class Template Reference}
  2. \label{classutl_1_1spi__bb__i}\index{utl\+::spi\+\_\+bb\+\_\+i$<$ impl\+\_\+t, C\+P\+O\+L, C\+P\+H\+A, Bit\+Order $>$@{utl\+::spi\+\_\+bb\+\_\+i$<$ impl\+\_\+t, C\+P\+O\+L, C\+P\+H\+A, Bit\+Order $>$}}
  3. A bit banking implementation of spi bus inherited from \mbox{\hyperlink{classutl_1_1spi__i}{spi\+\_\+i}} base class.
  4. {\ttfamily \#include $<$spi\+\_\+bb.\+h$>$}
  5. Inheritance diagram for utl\+:\+:spi\+\_\+bb\+\_\+i$<$ impl\+\_\+t, C\+P\+OL, C\+P\+HA, Bit\+Order $>$\+:\begin{figure}[H]
  6. \begin{center}
  7. \leavevmode
  8. \includegraphics[height=2.000000cm]{classutl_1_1spi__bb__i}
  9. \end{center}
  10. \end{figure}
  11. \subsection*{Public Types}
  12. \begin{DoxyCompactItemize}
  13. \item
  14. using \mbox{\hyperlink{classutl_1_1spi__bb__i_a86ccf004bf5ccc8b7c73bd0f9e8dbaa7}{type}} = \mbox{\hyperlink{classutl_1_1spi__bb__i}{spi\+\_\+bb\+\_\+i}}$<$ impl\+\_\+t, C\+P\+OL, C\+P\+HA, Bit\+Order $>$
  15. \begin{DoxyCompactList}\small\item\em Export type as identity meta-\/function. \end{DoxyCompactList}\end{DoxyCompactItemize}
  16. \subsection*{Protected Member Functions}
  17. \begin{Indent}\textbf{ Object lifetime}\par
  18. \begin{DoxyCompactItemize}
  19. \item
  20. \mbox{\hyperlink{classutl_1_1spi__bb__i_aeac57567cb7db5ebb73bdd8e1f00cb82}{$\sim$spi\+\_\+bb\+\_\+i}} ()=default
  21. \item
  22. \mbox{\hyperlink{classutl_1_1spi__bb__i_a49a61ba9a8e140e45d73e1f634061c6a}{spi\+\_\+bb\+\_\+i}} (uint32\+\_\+t clk) noexcept
  23. \begin{DoxyCompactList}\small\item\em A default constructor. \end{DoxyCompactList}\end{DoxyCompactItemize}
  24. \end{Indent}
  25. \subsection*{Additional Inherited Members}
  26. \subsection{Detailed Description}
  27. \subsubsection*{template$<$typename impl\+\_\+t, spi\+::cpol C\+P\+OL, spi\+::cpha C\+P\+HA, spi\+::bit\+Order Bit\+Order = spi\+::bit\+Order\+::\+M\+S\+B\+\_\+\+First$>$\newline
  28. class utl\+::spi\+\_\+bb\+\_\+i$<$ impl\+\_\+t, C\+P\+O\+L, C\+P\+H\+A, Bit\+Order $>$}
  29. A bit banking implementation of spi bus inherited from \mbox{\hyperlink{classutl_1_1spi__i}{spi\+\_\+i}} base class.
  30. \begin{DoxySeeAlso}{See also}
  31. \mbox{\hyperlink{classutl_1_1spi__i}{spi\+\_\+i}}
  32. \end{DoxySeeAlso}
  33. S\+PI bit banking interface template class using C\+R\+TP. Using the private interface we provide the interface from spi\+\_\+i$<$impl\+\_\+t$>$
  34. \begin{DoxyParams}{Parameters}
  35. {\em impl\+\_\+t} & The C\+R\+TP type (the derived/implementation class typename). \\
  36. \hline
  37. {\em C\+P\+OL} & Clock polarity \\
  38. \hline
  39. {\em C\+P\+HA} & Clock phase \\
  40. \hline
  41. {\em Bit\+Order} & Data transfer bit order \\
  42. \hline
  43. \end{DoxyParams}
  44. Definition at line 56 of file spi\+\_\+bb.\+h.
  45. \subsection{Member Typedef Documentation}
  46. \mbox{\Hypertarget{classutl_1_1spi__bb__i_a86ccf004bf5ccc8b7c73bd0f9e8dbaa7}\label{classutl_1_1spi__bb__i_a86ccf004bf5ccc8b7c73bd0f9e8dbaa7}}
  47. \index{utl\+::spi\+\_\+bb\+\_\+i@{utl\+::spi\+\_\+bb\+\_\+i}!type@{type}}
  48. \index{type@{type}!utl\+::spi\+\_\+bb\+\_\+i@{utl\+::spi\+\_\+bb\+\_\+i}}
  49. \subsubsection{\texorpdfstring{type}{type}}
  50. {\footnotesize\ttfamily template$<$typename impl\+\_\+t, spi\+::cpol C\+P\+OL, spi\+::cpha C\+P\+HA, spi\+::bit\+Order Bit\+Order = spi\+::bit\+Order\+::\+M\+S\+B\+\_\+\+First$>$ \\
  51. using \mbox{\hyperlink{classutl_1_1spi__bb__i}{utl\+::spi\+\_\+bb\+\_\+i}}$<$ impl\+\_\+t, C\+P\+OL, C\+P\+HA, Bit\+Order $>$\+::\mbox{\hyperlink{classutl_1_1spi__i_aff8ee0a2160cddbb52fce46611a6108f}{type}} = \mbox{\hyperlink{classutl_1_1spi__bb__i}{spi\+\_\+bb\+\_\+i}}$<$impl\+\_\+t, C\+P\+OL, C\+P\+HA, Bit\+Order$>$}
  52. Export type as identity meta-\/function.
  53. Definition at line 60 of file spi\+\_\+bb.\+h.
  54. \subsection{Constructor \& Destructor Documentation}
  55. \mbox{\Hypertarget{classutl_1_1spi__bb__i_aeac57567cb7db5ebb73bdd8e1f00cb82}\label{classutl_1_1spi__bb__i_aeac57567cb7db5ebb73bdd8e1f00cb82}}
  56. \index{utl\+::spi\+\_\+bb\+\_\+i@{utl\+::spi\+\_\+bb\+\_\+i}!````~spi\+\_\+bb\+\_\+i@{$\sim$spi\+\_\+bb\+\_\+i}}
  57. \index{````~spi\+\_\+bb\+\_\+i@{$\sim$spi\+\_\+bb\+\_\+i}!utl\+::spi\+\_\+bb\+\_\+i@{utl\+::spi\+\_\+bb\+\_\+i}}
  58. \subsubsection{\texorpdfstring{$\sim$spi\+\_\+bb\+\_\+i()}{~spi\_bb\_i()}}
  59. {\footnotesize\ttfamily template$<$typename impl\+\_\+t, spi\+::cpol C\+P\+OL, spi\+::cpha C\+P\+HA, spi\+::bit\+Order Bit\+Order = spi\+::bit\+Order\+::\+M\+S\+B\+\_\+\+First$>$ \\
  60. \mbox{\hyperlink{classutl_1_1spi__bb__i}{utl\+::spi\+\_\+bb\+\_\+i}}$<$ impl\+\_\+t, C\+P\+OL, C\+P\+HA, Bit\+Order $>$\+::$\sim$\mbox{\hyperlink{classutl_1_1spi__bb__i}{spi\+\_\+bb\+\_\+i}} (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [default]}}
  61. A default destructor, allow destructor from derived only \mbox{\Hypertarget{classutl_1_1spi__bb__i_a49a61ba9a8e140e45d73e1f634061c6a}\label{classutl_1_1spi__bb__i_a49a61ba9a8e140e45d73e1f634061c6a}}
  62. \index{utl\+::spi\+\_\+bb\+\_\+i@{utl\+::spi\+\_\+bb\+\_\+i}!spi\+\_\+bb\+\_\+i@{spi\+\_\+bb\+\_\+i}}
  63. \index{spi\+\_\+bb\+\_\+i@{spi\+\_\+bb\+\_\+i}!utl\+::spi\+\_\+bb\+\_\+i@{utl\+::spi\+\_\+bb\+\_\+i}}
  64. \subsubsection{\texorpdfstring{spi\+\_\+bb\+\_\+i()}{spi\_bb\_i()}}
  65. {\footnotesize\ttfamily template$<$typename impl\+\_\+t, spi\+::cpol C\+P\+OL, spi\+::cpha C\+P\+HA, spi\+::bit\+Order Bit\+Order = spi\+::bit\+Order\+::\+M\+S\+B\+\_\+\+First$>$ \\
  66. \mbox{\hyperlink{classutl_1_1spi__bb__i}{utl\+::spi\+\_\+bb\+\_\+i}}$<$ impl\+\_\+t, C\+P\+OL, C\+P\+HA, Bit\+Order $>$\+::\mbox{\hyperlink{classutl_1_1spi__bb__i}{spi\+\_\+bb\+\_\+i}} (\begin{DoxyParamCaption}\item[{uint32\+\_\+t}]{clk }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}, {\ttfamily [noexcept]}}
  67. A default constructor.
  68. Definition at line 69 of file spi\+\_\+bb.\+h.
  69. The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
  70. \item
  71. include/utl/com/\mbox{\hyperlink{spi__bb_8h}{spi\+\_\+bb.\+h}}\end{DoxyCompactItemize}