|
- \hypertarget{spi_8h}{}\section{include/utl/com/spi.h File Reference}
- \label{spi_8h}\index{include/utl/com/spi.\+h@{include/utl/com/spi.\+h}}
-
-
- An Abstract base class interface for the spi bus.
-
-
- {\ttfamily \#include $<$utl/core/impl.\+h$>$}\newline
- {\ttfamily \#include $<$utl/core/crtp.\+h$>$}\newline
- {\ttfamily \#include $<$utl/meta/meta.\+h$>$}\newline
- \subsection*{Classes}
- \begin{DoxyCompactItemize}
- \item
- class \mbox{\hyperlink{classutl_1_1spi__i}{utl\+::spi\+\_\+i$<$ impl\+\_\+t $>$}}
- \item
- class \mbox{\hyperlink{classutl_1_1spi__i_3_01virtual__tag_01_4}{utl\+::spi\+\_\+i$<$ virtual\+\_\+tag $>$}}
- \begin{DoxyCompactList}\small\item\em A virtual base class implementation. \end{DoxyCompactList}\item
- struct \mbox{\hyperlink{structutl_1_1spi__i__details_1_1is__spi__}{utl\+::spi\+\_\+i\+\_\+details\+::is\+\_\+spi\+\_\+$<$ \+\_\+\+Tp, typename $>$}}
- \begin{DoxyCompactList}\small\item\em Primary template to catch any non S\+PI interface types. \end{DoxyCompactList}\item
- struct \mbox{\hyperlink{structutl_1_1spi__i__details_1_1is__spi___3_01___tp_00_01meta_1_1void__t_3_01meta_1_1use__if__sa2db29f6d65d34ecf5e49ec30b6600d78}{utl\+::spi\+\_\+i\+\_\+details\+::is\+\_\+spi\+\_\+$<$ \+\_\+\+Tp, meta\+::void\+\_\+t$<$ meta\+::use\+\_\+if\+\_\+same\+\_\+t$<$ try\+\_\+cclock\+\_\+t$<$ \+\_\+\+Tp $>$, uint32\+\_\+t $>$, meta\+::use\+\_\+if\+\_\+same\+\_\+t$<$ try\+\_\+clock\+\_\+t$<$ \+\_\+\+Tp $>$, void $>$, meta\+::use\+\_\+if\+\_\+same\+\_\+t$<$ try\+\_\+tx\+\_\+t$<$ \+\_\+\+Tp $>$, byte\+\_\+t $>$, meta\+::use\+\_\+if\+\_\+same\+\_\+t$<$ try\+\_\+rx\+\_\+t$<$ \+\_\+\+Tp $>$, byte\+\_\+t $>$ $>$ $>$}}
- \begin{DoxyCompactList}\small\item\em template to catch a proper S\+PI interface type \end{DoxyCompactList}\end{DoxyCompactItemize}
- \subsection*{Namespaces}
- \begin{DoxyCompactItemize}
- \item
- \mbox{\hyperlink{namespaceutl}{utl}}
- \begin{DoxyCompactList}\small\item\em S\+TL\textquotesingle{}s core language concepts. \end{DoxyCompactList}\item
- \mbox{\hyperlink{namespaceutl_1_1spi}{utl\+::spi}}
- \begin{DoxyCompactList}\small\item\em Abstract base class for spi bus. \end{DoxyCompactList}\item
- \mbox{\hyperlink{namespaceutl_1_1spi__i__details}{utl\+::spi\+\_\+i\+\_\+details}}
- \end{DoxyCompactItemize}
- \subsection*{Typedefs}
- \begin{DoxyCompactItemize}
- \item
- {\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1spi__i__details_ae1a4fad6acf8faccc5e85ee9b710c109}{utl\+::spi\+\_\+i\+\_\+details\+::try\+\_\+cclock\+\_\+t}} = decltype(declval$<$ const \+\_\+\+Tp $>$().clock())
- \item
- {\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1spi__i__details_af2f4800aa77af82767a3ac55b9b242a6}{utl\+::spi\+\_\+i\+\_\+details\+::try\+\_\+clock\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().clock(declval$<$ uint32\+\_\+t $>$()))
- \item
- {\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1spi__i__details_a755d8f10cfde3f5c3b9900eb11c858bd}{utl\+::spi\+\_\+i\+\_\+details\+::try\+\_\+tx\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().tx\+\_\+data(declval$<$ byte\+\_\+t $>$()))
- \item
- {\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1spi__i__details_a4dcf3c71fddf790e45a3be2c19906c97}{utl\+::spi\+\_\+i\+\_\+details\+::try\+\_\+rx\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().rx\+\_\+data())
- \end{DoxyCompactItemize}
- \subsection*{Enumerations}
- \begin{DoxyCompactItemize}
- \item
- enum \mbox{\hyperlink{namespaceutl_1_1spi_aed6b713381c193c598572ebac0b284cc}{utl\+::spi\+::bit\+Order}} \{ \mbox{\hyperlink{namespaceutl_1_1spi_aed6b713381c193c598572ebac0b284cca6db67adee32c3bd4ff03acf3244e1b4b}{utl\+::spi\+::bit\+Order\+::\+L\+S\+B\+\_\+\+First}} =0x01,
- \mbox{\hyperlink{namespaceutl_1_1spi_aed6b713381c193c598572ebac0b284cca47bde70fdcc82c8363d16c7137641b79}{utl\+::spi\+::bit\+Order\+::\+M\+S\+B\+\_\+\+First}} =0x80
- \}
- \item
- enum \mbox{\hyperlink{namespaceutl_1_1spi_a89e3e1af5df0b6c37239f7e336969f8a}{utl\+::spi\+::cpol}} \{ \mbox{\hyperlink{namespaceutl_1_1spi_a89e3e1af5df0b6c37239f7e336969f8aa41bc94cbd8eebea13ce0491b2ac11b88}{utl\+::spi\+::cpol\+::\+L\+OW}} =0,
- \mbox{\hyperlink{namespaceutl_1_1spi_a89e3e1af5df0b6c37239f7e336969f8aab89de3b4b81c4facfac906edf29aec8c}{utl\+::spi\+::cpol\+::\+H\+I\+GH}}
- \}
- \item
- enum \mbox{\hyperlink{namespaceutl_1_1spi_aa49fe33d495226891cef0a870cba59df}{utl\+::spi\+::cpha}} \{ \mbox{\hyperlink{namespaceutl_1_1spi_aa49fe33d495226891cef0a870cba59dfa41bc94cbd8eebea13ce0491b2ac11b88}{utl\+::spi\+::cpha\+::\+L\+OW}} =0,
- \mbox{\hyperlink{namespaceutl_1_1spi_aa49fe33d495226891cef0a870cba59dfab89de3b4b81c4facfac906edf29aec8c}{utl\+::spi\+::cpha\+::\+H\+I\+GH}}
- \}
- \end{DoxyCompactItemize}
-
-
- \subsection{Detailed Description}
- An Abstract base class interface for the spi bus.
-
- Copyright (C) 2018 Christos Choutouridis
-
- This program is free software\+: you can redistribute it and/or modify it under the terms of the G\+NU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
-
- This program is distributed in the hope that it will be useful, but W\+I\+T\+H\+O\+UT A\+NY W\+A\+R\+R\+A\+N\+TY; without even the implied warranty of M\+E\+R\+C\+H\+A\+N\+T\+A\+B\+I\+L\+I\+TY or F\+I\+T\+N\+E\+SS F\+OR A P\+A\+R\+T\+I\+C\+U\+L\+AR P\+U\+R\+P\+O\+SE. See the G\+NU Lesser General Public License for more details.
-
- You should have received a copy of the G\+NU Lesser General Public License along with this program. If not, see \href{http://www.gnu.org/licenses/}{\tt http\+://www.\+gnu.\+org/licenses/}.
|
