aboutsummaryrefslogtreecommitdiffhomepage
path: root/source/Core/Drivers/FUSB302/protocol_tx.h
blob: 4ce1626d08bceb54c716942a96543166301b64c1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/*
 * PD Buddy Firmware Library - USB Power Delivery for everyone
 * Copyright 2017-2018 Clayton G. Hobbs
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef PDB_PROTOCOL_TX_H
#define PDB_PROTOCOL_TX_H

#include <stdint.h>
#include "policy_engine.h"
#include "protocol_rx.h"
#include <pd.h>

/* Events for the Protocol TX thread */

class ProtocolTransmit {
public:
	static void init();
	//Push a message to the queue to be sent out the pd comms bus
	static void pushMessage(union pd_msg *msg);

	enum class Notifications {

		PDB_EVT_PRLTX_RESET = EVENT_MASK(0), //
		PDB_EVT_PRLTX_I_TXSENT = EVENT_MASK(1), //
		PDB_EVT_PRLTX_I_RETRYFAIL = EVENT_MASK(2), //
		PDB_EVT_PRLTX_DISCARD = EVENT_MASK(3), //
		PDB_EVT_PRLTX_MSG_TX = EVENT_MASK(4), //
		PDB_EVT_PRLTX_START_AMS = EVENT_MASK(5), //
	};
	static void notify(Notifications notification);
private:
	static void thread(const void *args);
	static EventGroupHandle_t xEventGroupHandle;
	static StaticEventGroup_t xCreatedEventGroup;
	static osThreadId TaskHandle;
	static const size_t TaskStackSize = 1024 / 4;
	static uint32_t TaskBuffer[TaskStackSize];
	static osStaticThreadDef_t TaskControlBlock;
	static bool messageSending;
	/*
	 * Protocol TX machine states
	 *
	 * Because the PHY can automatically send retries, the Check_RetryCounter state
	 * has been removed, transitions relating to it are modified appropriately, and
	 * we don't even keep a RetryCounter.
	 */
	enum protocol_tx_state {
		PRLTxPHYReset,
		PRLTxWaitMessage,
		PRLTxReset,
		PRLTxConstructMessage,
		PRLTxWaitResponse,
		PRLTxMatchMessageID,
		PRLTxTransmissionError,
		PRLTxMessageSent,
		PRLTxDiscardMessage
	};
	//Internal states
	static protocol_tx_state protocol_tx_discard_message();
	static protocol_tx_state protocol_tx_message_sent();
	static protocol_tx_state protocol_tx_transmission_error();
	static protocol_tx_state protocol_tx_match_messageid();
	static protocol_tx_state protocol_tx_wait_response();
	static protocol_tx_state protocol_tx_construct_message();
	static protocol_tx_state protocol_tx_reset();
	static protocol_tx_state protocol_tx_wait_message();
	static protocol_tx_state protocol_tx_phy_reset();
	//queue of up to PDB_MSG_POOL_SIZE messages to send
	static StaticQueue_t xStaticQueue;
	/* The array to use as the queue's storage area.  This must be at least
	 uxQueueLength * uxItemSize bytes. */
	static uint8_t ucQueueStorageArea[PDB_MSG_POOL_SIZE * sizeof(union pd_msg)];
	static QueueHandle_t messagesWaiting;
	static uint8_t _tx_messageidcounter;
	static bool messagePending();
	//Reads a message off the queue into the temp message
	static void getMessage();
	static union pd_msg temp_msg;
	static Notifications waitForEvent(uint32_t mask, TickType_t ticksToWait =
	portMAX_DELAY);

};

#endif /* PDB_PROTOCOL_TX_H */