wavelength 1.0.0
Loading...
Searching...
No Matches
cxtmodem.h
Go to the documentation of this file.
1#pragma once
2
3#include <kernel.h>
4#include <modem.h>
5#include <usbd.h>
6
8struct UsbEndpoint {
9 int pipe;
10 int pending;
11 bool blocked;
12};
13
16 unsigned char command;
17 unsigned char index;
18 unsigned char value;
19};
20
23 unsigned char reserved[2];
24 unsigned char mode;
25 unsigned char lines;
26};
27
36class CxtModem {
37public:
44
46 static constexpr unsigned char kRegisterWriteCommand = 0x40;
47
49 enum LineBit {
50 kLineActive = 0x01,
53 };
54
62 static int Probe(int deviceId);
63
72 static int Connect(int deviceId);
73
82 static int Disconnect(int deviceId);
83
86
88 static int sDeviceFound;
89
91 static constexpr int kDialStringSize = 1024;
92
95
96private:
98 enum State {
99 kStateIdle = 0,
100 kStateStarting = 1,
101 kStateReady = 2,
102 kStateConnected = 3,
103 kStateDisconnecting = 4,
104 kStateUnplugged = 5,
105 };
106
108 static constexpr int kRegisterCount = 8;
109
111 static constexpr int kEndpointCount = 16;
112
114 static constexpr int kTransmitBufferSize = 0x400;
115
117 static constexpr int kTransmitChunkSize = 16;
118
120 static constexpr int kReceiveBufferSize = 0x1000;
121
123 static constexpr int kStagedWriteCount = 16;
124
126 static constexpr int kInputBufferSize = 32;
127
129 static constexpr int kVendorNameSize = 31;
130
132 static constexpr int kProductNameSize = 33;
133
141 void NotifyModem(unsigned int events);
142
150 void Signal(unsigned int events);
151
162 static int Send(void *modem, const void *data, int length);
163
172 int Write(const char *data, int length);
173
184 static int Control(void *modem, unsigned int command, void *buffer, int size);
185
192 unsigned char ModemStatus() const;
193
201 static int Start(void *modem);
202
210 static unsigned int AlarmHandler(void *modem);
211
218 unsigned int PendingEvents() const;
219
227 int WaitEvents(unsigned int mask);
228
235 static void StatusThread(void *modem);
236
243 static void EventThread(void *modem);
244
251 static void DownloadThread(void *modem);
252
259 static CxtModem *Create();
260
266 void Destroy();
267
275 static int Stop(void *modem);
276
282 void UpdateFlowControl();
283
293 static int Receive(void *modem, void *data, int length);
294
303 int Read(char *data, int length);
304
313 static void SetInterfaceDone(int result, int count, void *modem);
314
323 static void SetConfigurationDone(int result, int count, void *modem);
324
332 void SetRegister(unsigned int index, unsigned char value);
333
341 void FlushTransmit(int unused);
342
349 char ReadByte();
350
357 bool IsTransmitFull() const;
358
365 void PutByte(char value);
366
375 static void RegisterTransferDone(int result, int count, void *modem);
376
385 static void TransmitDone(int result, int count, void *modem);
386
396 static void ReceiveDone(int result, int count, void *modem);
397
406 void ParseInput(const unsigned char *data, int pairs);
407
414 bool HasInput() const;
415
426 int Transfer(UsbEndpoint *endpoint, void *data, int length, UsbdDoneCallback callback);
427
433 void StartReceive();
434
440 void FlushRegisters();
441
447 void RegistersWritten();
448
457 static void ControlPacketDone(int result, int count, void *modem);
458
464 void SendControlPacket();
465
473 void UpdateMode(unsigned char set, unsigned char clear);
474
482 void UpdateLines(unsigned char set, unsigned char clear);
483
490 void Configure(int phase);
491
493 void ProgramSerialPort();
494
495 int mDeviceId;
496 unsigned int mReserved0; // +0x04
497 unsigned char mReserved1; // +0x08
498 bool mConfigured;
499 bool mRegistersDirty;
500 bool mInterfaceSelected;
501 unsigned int mReserved2; // +0x0c
502 int mControlPipe;
503 unsigned int mReserved3; // +0x14
504 UsbEndpoint mEndpoints[kEndpointCount];
505 unsigned char mTransmitBuffer[kTransmitBufferSize];
506 unsigned char mTransmitChunk[kTransmitChunkSize];
507 int mTransmitLength;
508 unsigned char mReceiveBuffer[kReceiveBufferSize];
509 unsigned char mRegisterValues[kRegisterCount];
510 unsigned char mRegisterPending[kRegisterCount];
511 ControlPacket mControlPacket;
512 bool mControlPacketPending;
513 unsigned char mRegisterWriteCommand;
514 int mReceiveRead;
515 int mReceiveWrite;
516 RegisterWrite mRegisterPacket[kStagedWriteCount];
517 RegisterWrite mStagedWrites[kStagedWriteCount];
518 int mStagedCount;
519 unsigned int mReserved4; // +0x1570
520 unsigned char mInputBuffer[kInputBufferSize];
521 unsigned int mFlags;
522 unsigned int mReserved5[2]; // +0x1598
523 int mTransmitDepth;
524 unsigned int mReserved6[2]; // +0x15a4
525 unsigned char mModemStatus;
526 unsigned int mReserved7[2]; // +0x15b0
527 int mTransmitSema;
528 unsigned int mReserved8[3]; // +0x15bc
529 SysClock mAlarmInterval;
530 unsigned char mClearedOnConfigure;
531 ModemDeviceOps mModem;
532 int mReceivedBytes;
533 int mSentBytes;
534 unsigned int mPendingEvents;
535 int mEventFlag;
536 int mEventThread;
537 int mStatusThread;
538 int mDownloadThread;
539 int mAlarmActive;
540 int mState;
541 int mReady;
542 int mCarrier;
543 int mRing;
544 int mStarted;
545 char mVendorName[kVendorNameSize];
546 char mProductName[kProductNameSize];
547 int mReceiveNotifications;
548};
A Conexant USB modem the driver attached to.
Definition cxtmodem.h:36
static int sDeviceFound
Whether a modem is attached, or for a normal load, whether to stay loaded.
Definition cxtmodem.h:88
static constexpr int kDialStringSize
Size of sDialString.
Definition cxtmodem.h:91
static int Disconnect(int deviceId)
Detach from a removed device.
static constexpr unsigned char kRegisterWriteCommand
Value written in each RegisterWrite.
Definition cxtmodem.h:46
LoadMode
Load modes the lmode argument selects.
Definition cxtmodem.h:39
@ kLoadModeNormal
Definition cxtmodem.h:40
@ kLoadModeAuto
Definition cxtmodem.h:41
@ kLoadModeTest
Definition cxtmodem.h:42
static char sDialString[kDialStringSize]
Value of the dial module argument.
Definition cxtmodem.h:94
static int Probe(int deviceId)
Report whether the driver takes a device.
LineBit
Line bits of the control packet.
Definition cxtmodem.h:49
@ kLineConnected
Definition cxtmodem.h:51
@ kLineActive
Definition cxtmodem.h:50
@ kLineReserved
Definition cxtmodem.h:52
static int Connect(int deviceId)
Attach to a device.
static LoadMode sLoadMode
Load mode from the module arguments.
Definition cxtmodem.h:85
Packet on the control endpoint.
Definition cxtmodem.h:22
unsigned char mode
Definition cxtmodem.h:24
unsigned char reserved[2]
Definition cxtmodem.h:23
unsigned char lines
Definition cxtmodem.h:25
One register write in a packet on the register endpoint.
Definition cxtmodem.h:15
unsigned char command
Definition cxtmodem.h:16
unsigned char value
Definition cxtmodem.h:18
unsigned char index
Definition cxtmodem.h:17
State of an endpoint pipe.
Definition cxtmodem.h:8
bool blocked
Definition cxtmodem.h:11
int pending
Definition cxtmodem.h:10
int pipe
Definition cxtmodem.h:9