USB Host Shield 2.0
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
ACM Class Reference

#include <cdcacm.h>

Inheritance diagram for ACM:
Inheritance graph
[legend]
Collaboration diagram for ACM:
Collaboration graph
[legend]

Public Member Functions

 ACM (USB *pusb, CDCAsyncOper *pasync)
 
uint8_t SetCommFeature (uint16_t fid, uint8_t nbytes, uint8_t *dataptr)
 
uint8_t GetCommFeature (uint16_t fid, uint8_t nbytes, uint8_t *dataptr)
 
uint8_t ClearCommFeature (uint16_t fid)
 
uint8_t SetLineCoding (const LINE_CODING *dataptr)
 
uint8_t GetLineCoding (LINE_CODING *dataptr)
 
uint8_t SetControlLineState (uint8_t state)
 
uint8_t SendBreak (uint16_t duration)
 
uint8_t GetNotif (uint16_t *bytes_rcvd, uint8_t *dataptr)
 
uint8_t RcvData (uint16_t *nbytesptr, uint8_t *dataptr)
 
uint8_t SndData (uint16_t nbytes, uint8_t *dataptr)
 
uint8_t Init (uint8_t parent, uint8_t port, bool lowspeed)
 
uint8_t Release ()
 
uint8_t Poll ()
 
bool available (void)
 
virtual uint8_t GetAddress ()
 
virtual bool isReady ()
 
virtual tty_features enhanced_status (void)
 
virtual tty_features enhanced_features (void)
 
virtual void autoflowRTS (bool s)
 
virtual void autoflowDSR (bool s)
 
virtual void autoflowXON (bool s)
 
virtual void half_duplex (bool s)
 
virtual void wide (bool s)
 
void EndpointXtract (uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const USB_ENDPOINT_DESCRIPTOR *ep)
 
- Public Member Functions inherited from USBDeviceConfig
virtual uint8_t ConfigureDevice (uint8_t parent, uint8_t port, bool lowspeed)
 
virtual void ResetHubPort (uint8_t port)
 
virtual bool VIDPIDOK (uint16_t vid, uint16_t pid)
 
virtual bool DEVCLASSOK (uint8_t klass)
 
virtual bool DEVSUBCLASSOK (uint8_t subklass)
 

Public Attributes

EpInfo epInfo [ACM_MAX_ENDPOINTS]
 

Static Public Attributes

static const uint8_t epDataInIndex = 1
 
static const uint8_t epDataOutIndex = 2
 
static const uint8_t epInterruptInIndex = 3
 

Protected Member Functions

void PrintEndpointDescriptor (const USB_ENDPOINT_DESCRIPTOR *ep_ptr)
 

Protected Attributes

USB * pUsb
 
CDCAsyncOper * pAsync
 
uint8_t bAddress
 
uint8_t bConfNum
 
uint8_t bControlIface
 
uint8_t bDataIface
 
uint8_t bNumEP
 
uint32_t qNextPollTime
 
volatile bool bPollEnable
 
volatile bool ready
 
tty_features _enhanced_status
 

Detailed Description

Definition at line 163 of file cdcacm.h.

Constructor & Destructor Documentation

◆ ACM()

ACM::ACM ( USB *  pusb,
CDCAsyncOper *  pasync 
)

Definition at line 23 of file cdcacm.cpp.

Member Function Documentation

◆ PrintEndpointDescriptor()

void ACM::PrintEndpointDescriptor ( const USB_ENDPOINT_DESCRIPTOR *  ep_ptr)
protected

Definition at line 352 of file cdcacm.cpp.

◆ SetCommFeature()

uint8_t ACM::SetCommFeature ( uint16_t  fid,
uint8_t  nbytes,
uint8_t *  dataptr 
)

Definition at line 296 of file cdcacm.cpp.

◆ GetCommFeature()

uint8_t ACM::GetCommFeature ( uint16_t  fid,
uint8_t  nbytes,
uint8_t *  dataptr 
)

Definition at line 304 of file cdcacm.cpp.

◆ ClearCommFeature()

uint8_t ACM::ClearCommFeature ( uint16_t  fid)

Definition at line 312 of file cdcacm.cpp.

◆ SetLineCoding()

uint8_t ACM::SetLineCoding ( const LINE_CODING *  dataptr)

Definition at line 320 of file cdcacm.cpp.

◆ GetLineCoding()

uint8_t ACM::GetLineCoding ( LINE_CODING *  dataptr)

Definition at line 328 of file cdcacm.cpp.

◆ SetControlLineState()

uint8_t ACM::SetControlLineState ( uint8_t  state)

Definition at line 336 of file cdcacm.cpp.

◆ SendBreak()

uint8_t ACM::SendBreak ( uint16_t  duration)

Definition at line 344 of file cdcacm.cpp.

◆ GetNotif()

uint8_t ACM::GetNotif ( uint16_t *  bytes_rcvd,
uint8_t *  dataptr 
)

◆ RcvData()

uint8_t ACM::RcvData ( uint16_t *  nbytesptr,
uint8_t *  dataptr 
)

Definition at line 280 of file cdcacm.cpp.

◆ SndData()

uint8_t ACM::SndData ( uint16_t  nbytes,
uint8_t *  dataptr 
)

Definition at line 288 of file cdcacm.cpp.

◆ Init()

uint8_t ACM::Init ( uint8_t  parent,
uint8_t  port,
bool  lowspeed 
)
virtual

Reimplemented from USBDeviceConfig.

Reimplemented in PL2303.

Definition at line 46 of file cdcacm.cpp.

◆ Release()

uint8_t ACM::Release ( )
virtual

Reimplemented from USBDeviceConfig.

Definition at line 258 of file cdcacm.cpp.

◆ Poll()

uint8_t ACM::Poll ( )
virtual

Reimplemented from USBDeviceConfig.

Definition at line 272 of file cdcacm.cpp.

◆ available()

bool ACM::available ( void  )
inline

Definition at line 205 of file cdcacm.h.

◆ GetAddress()

virtual uint8_t ACM::GetAddress ( )
inlinevirtual

Reimplemented from USBDeviceConfig.

Definition at line 209 of file cdcacm.h.

◆ isReady()

virtual bool ACM::isReady ( )
inlinevirtual

Definition at line 213 of file cdcacm.h.

◆ enhanced_status()

virtual tty_features ACM::enhanced_status ( void  )
inlinevirtual

Definition at line 217 of file cdcacm.h.

◆ enhanced_features()

virtual tty_features ACM::enhanced_features ( void  )
inlinevirtual

Reimplemented in XR21B1411.

Definition at line 221 of file cdcacm.h.

◆ autoflowRTS()

virtual void ACM::autoflowRTS ( bool  s)
inlinevirtual

Reimplemented in XR21B1411.

Definition at line 232 of file cdcacm.h.

◆ autoflowDSR()

virtual void ACM::autoflowDSR ( bool  s)
inlinevirtual

Reimplemented in XR21B1411.

Definition at line 235 of file cdcacm.h.

◆ autoflowXON()

virtual void ACM::autoflowXON ( bool  s)
inlinevirtual

Reimplemented in XR21B1411.

Definition at line 238 of file cdcacm.h.

◆ half_duplex()

virtual void ACM::half_duplex ( bool  s)
inlinevirtual

Reimplemented in XR21B1411.

Definition at line 241 of file cdcacm.h.

◆ wide()

virtual void ACM::wide ( bool  s)
inlinevirtual

Definition at line 244 of file cdcacm.h.

◆ EndpointXtract()

void ACM::EndpointXtract ( uint8_t  conf,
uint8_t  iface,
uint8_t  alt,
uint8_t  proto,
const USB_ENDPOINT_DESCRIPTOR *  ep 
)
virtual

Reimplemented from UsbConfigXtracter.

Definition at line 231 of file cdcacm.cpp.

Member Data Documentation

◆ pUsb

USB* ACM::pUsb
protected

Definition at line 165 of file cdcacm.h.

◆ pAsync

CDCAsyncOper* ACM::pAsync
protected

Definition at line 166 of file cdcacm.h.

◆ bAddress

uint8_t ACM::bAddress
protected

Definition at line 167 of file cdcacm.h.

◆ bConfNum

uint8_t ACM::bConfNum
protected

Definition at line 168 of file cdcacm.h.

◆ bControlIface

uint8_t ACM::bControlIface
protected

Definition at line 169 of file cdcacm.h.

◆ bDataIface

uint8_t ACM::bDataIface
protected

Definition at line 170 of file cdcacm.h.

◆ bNumEP

uint8_t ACM::bNumEP
protected

Definition at line 171 of file cdcacm.h.

◆ qNextPollTime

uint32_t ACM::qNextPollTime
protected

Definition at line 172 of file cdcacm.h.

◆ bPollEnable

volatile bool ACM::bPollEnable
protected

Definition at line 173 of file cdcacm.h.

◆ ready

volatile bool ACM::ready
protected

Definition at line 174 of file cdcacm.h.

◆ _enhanced_status

tty_features ACM::_enhanced_status
protected

Definition at line 175 of file cdcacm.h.

◆ epDataInIndex

const uint8_t ACM::epDataInIndex = 1
static

Definition at line 180 of file cdcacm.h.

◆ epDataOutIndex

const uint8_t ACM::epDataOutIndex = 2
static

Definition at line 181 of file cdcacm.h.

◆ epInterruptInIndex

const uint8_t ACM::epInterruptInIndex = 3
static

Definition at line 182 of file cdcacm.h.

◆ epInfo

EpInfo ACM::epInfo[ACM_MAX_ENDPOINTS]

Definition at line 183 of file cdcacm.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.1