Skip to content

Commit 77406b4

Browse files
DvdGiessendpgeorge
DvdGiessen
authored and
dpgeorge
committed
extmod/network_ppp: Allow stream=None to suspend PPP.
This allows the stream to be set to `None`, which essentially stops all PPP communication without disconnecting the session. This allows replacing the stream on-the-fly to suspend it, for example to send AT commands to a modem without completely disconnecting and re-establishing the PPP connection: uart = ppp.config('stream') ppp.config(stream=None) uart.write(b'+++') # do some AT commands uart.write(b'ATO\r\n') ppp.config(stream=uart) Any attempted communication by PPP while the stream is not connected will register as simple packet loss to the LwIP stack because we return 0 for any write calls, and protocols like TCP will then automatically handle retrying. Signed-off-by: Daniël van de Giessen <daniel@dvdgiessen.nl>
1 parent 161e2bd commit 77406b4

File tree

2 files changed

+72
-25
lines changed

2 files changed

+72
-25
lines changed

‎extmod/network_ppp_lwip.c‎

Lines changed: 50 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,18 @@ const mp_obj_type_t mp_network_ppp_lwip_type;
6060

6161
static mp_obj_t network_ppp___del__(mp_obj_t self_in);
6262

63+
static void network_ppp_stream_uart_irq_disable(network_ppp_obj_t *self) {
64+
if (self->stream == mp_const_none) {
65+
return;
66+
}
67+
68+
// Disable UART IRQ.
69+
mp_obj_t dest[3];
70+
mp_load_method(self->stream, MP_QSTR_irq, dest);
71+
dest[2] = mp_const_none;
72+
mp_call_method_n_kw(1, 0, dest);
73+
}
74+
6375
static void network_ppp_status_cb(ppp_pcb *pcb, int err_code, void *ctx) {
6476
network_ppp_obj_t *self = ctx;
6577
switch (err_code) {
@@ -68,12 +80,9 @@ static void network_ppp_status_cb(ppp_pcb *pcb, int err_code, void *ctx) {
6880
break;
6981
case PPPERR_USER:
7082
if (self->state >= STATE_ERROR) {
71-
// Disable UART IRQ.
72-
mp_obj_t dest[3];
73-
mp_load_method(self->stream, MP_QSTR_irq, dest);
74-
dest[2] = mp_const_none;
75-
mp_call_method_n_kw(1, 0, dest);
76-
// Indicate that the IRQ is disabled.
83+
network_ppp_stream_uart_irq_disable(self);
84+
// Indicate that we are no longer connected and thus
85+
// only need to free the PPP PCB, not close it.
7786
self->state = STATE_ACTIVE;
7887
}
7988
// Clean up the PPP PCB.
@@ -91,7 +100,9 @@ static mp_obj_t network_ppp_make_new(const mp_obj_type_t *type, size_t n_args, s
91100

92101
mp_obj_t stream = all_args[0];
93102

94-
mp_get_stream_raise(stream, MP_STREAM_OP_READ | MP_STREAM_OP_WRITE);
103+
if (stream != mp_const_none) {
104+
mp_get_stream_raise(stream, MP_STREAM_OP_READ | MP_STREAM_OP_WRITE);
105+
}
95106

96107
network_ppp_obj_t *self = mp_obj_malloc_with_finaliser(network_ppp_obj_t, type);
97108
self->state = STATE_INACTIVE;
@@ -105,7 +116,7 @@ static mp_obj_t network_ppp___del__(mp_obj_t self_in) {
105116
network_ppp_obj_t *self = MP_OBJ_TO_PTR(self_in);
106117
if (self->state >= STATE_ACTIVE) {
107118
if (self->state >= STATE_ERROR) {
108-
// Still connected over the UART stream.
119+
// Still connected over the stream.
109120
// Force the connection to close, with nocarrier=1.
110121
self->state = STATE_INACTIVE;
111122
ppp_close(self->pcb, 1);
@@ -127,10 +138,11 @@ static mp_obj_t network_ppp_poll(size_t n_args, const mp_obj_t *args) {
127138
}
128139

129140
mp_int_t total_len = 0;
130-
for (;;) {
141+
mp_obj_t stream = self->stream;
142+
while (stream != mp_const_none) {
131143
uint8_t buf[256];
132144
int err;
133-
mp_uint_t len = mp_stream_rw(self->stream, buf, sizeof(buf), &err, 0);
145+
mp_uint_t len = mp_stream_rw(stream, buf, sizeof(buf), &err, 0);
134146
if (len == 0) {
135147
break;
136148
}
@@ -149,6 +161,19 @@ static mp_obj_t network_ppp_poll(size_t n_args, const mp_obj_t *args) {
149161
}
150162
static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(network_ppp_poll_obj, 1, 2, network_ppp_poll);
151163

164+
static void network_ppp_stream_uart_irq_enable(network_ppp_obj_t *self) {
165+
if (self->stream == mp_const_none) {
166+
return;
167+
}
168+
169+
// Enable UART IRQ to call PPP.poll() when incoming data is ready.
170+
mp_obj_t dest[4];
171+
mp_load_method(self->stream, MP_QSTR_irq, dest);
172+
dest[2] = mp_obj_new_bound_meth(MP_OBJ_FROM_PTR(&network_ppp_poll_obj), MP_OBJ_FROM_PTR(self));
173+
dest[3] = mp_load_attr(self->stream, MP_QSTR_IRQ_RXIDLE);
174+
mp_call_method_n_kw(2, 0, dest);
175+
}
176+
152177
static mp_obj_t network_ppp_config(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs) {
153178
if (n_args != 1 && kwargs->used != 0) {
154179
mp_raise_TypeError(MP_ERROR_TEXT("either pos or kw args are allowed"));
@@ -160,8 +185,16 @@ static mp_obj_t network_ppp_config(size_t n_args, const mp_obj_t *args, mp_map_t
160185
if (mp_map_slot_is_filled(kwargs, i)) {
161186
switch (mp_obj_str_get_qstr(kwargs->table[i].key)) {
162187
case MP_QSTR_stream: {
163-
mp_get_stream_raise(kwargs->table[i].value, MP_STREAM_OP_READ | MP_STREAM_OP_WRITE);
188+
if (kwargs->table[i].value != mp_const_none) {
189+
mp_get_stream_raise(kwargs->table[i].value, MP_STREAM_OP_READ | MP_STREAM_OP_WRITE);
190+
}
191+
if (self->state >= STATE_ACTIVE) {
192+
network_ppp_stream_uart_irq_disable(self);
193+
}
164194
self->stream = kwargs->table[i].value;
195+
if (self->state >= STATE_ACTIVE) {
196+
network_ppp_stream_uart_irq_enable(self);
197+
}
165198
break;
166199
}
167200
default:
@@ -210,10 +243,14 @@ static u32_t network_ppp_output_callback(ppp_pcb *pcb, const void *data, u32_t l
210243
}
211244
mp_printf(&mp_plat_print, ")\n");
212245
#endif
246+
mp_obj_t stream = self->stream;
247+
if (stream == mp_const_none) {
248+
return 0;
249+
}
213250
int err;
214251
// The return value from this output callback is the number of bytes written out.
215252
// If it's less than the requested number of bytes then lwIP will propagate out an error.
216-
return mp_stream_rw(self->stream, (void *)data, len, &err, MP_STREAM_RW_WRITE);
253+
return mp_stream_rw(stream, (void *)data, len, &err, MP_STREAM_RW_WRITE);
217254
}
218255

219256
static mp_obj_t network_ppp_connect(size_t n_args, const mp_obj_t *args, mp_map_t *kw_args) {
@@ -236,12 +273,7 @@ static mp_obj_t network_ppp_connect(size_t n_args, const mp_obj_t *args, mp_map_
236273
}
237274
self->state = STATE_ACTIVE;
238275

239-
// Enable UART IRQ to call PPP.poll() when incoming data is ready.
240-
mp_obj_t dest[4];
241-
mp_load_method(self->stream, MP_QSTR_irq, dest);
242-
dest[2] = mp_obj_new_bound_meth(MP_OBJ_FROM_PTR(&network_ppp_poll_obj), MP_OBJ_FROM_PTR(self));
243-
dest[3] = mp_load_attr(self->stream, MP_QSTR_IRQ_RXIDLE);
244-
mp_call_method_n_kw(2, 0, dest);
276+
network_ppp_stream_uart_irq_enable(self);
245277
}
246278

247279
if (self->state == STATE_CONNECTING || self->state == STATE_CONNECTED) {

‎ports/esp32/network_ppp.c‎

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,9 @@ static void ppp_status_cb(ppp_pcb *pcb, int err_code, void *ctx) {
8585
}
8686

8787
static mp_obj_t ppp_make_new(mp_obj_t stream) {
88-
mp_get_stream_raise(stream, MP_STREAM_OP_READ | MP_STREAM_OP_WRITE);
88+
if (stream != mp_const_none) {
89+
mp_get_stream_raise(stream, MP_STREAM_OP_READ | MP_STREAM_OP_WRITE);
90+
}
8991

9092
ppp_if_obj_t *self = mp_obj_malloc_with_finaliser(ppp_if_obj_t, &ppp_if_type);
9193
self->stream = stream;
@@ -100,8 +102,14 @@ MP_DEFINE_CONST_FUN_OBJ_1(esp_network_ppp_make_new_obj, ppp_make_new);
100102

101103
static u32_t ppp_output_callback(ppp_pcb *pcb, u8_t *data, u32_t len, void *ctx) {
102104
ppp_if_obj_t *self = ctx;
105+
106+
mp_obj_t stream = self->stream;
107+
if (stream == mp_const_none) {
108+
return 0;
109+
}
110+
103111
int err;
104-
return mp_stream_rw(self->stream, data, len, &err, MP_STREAM_RW_WRITE);
112+
return mp_stream_rw(stream, data, len, &err, MP_STREAM_RW_WRITE);
105113
}
106114

107115
static void pppos_client_task(void *self_in) {
@@ -110,10 +118,15 @@ static void pppos_client_task(void *self_in) {
110118

111119
int len = 0;
112120
while (ulTaskNotifyTake(pdTRUE, len <= 0) == 0) {
113-
int err;
114-
len = mp_stream_rw(self->stream, buf, sizeof(buf), &err, 0);
115-
if (len > 0) {
116-
pppos_input_tcpip(self->pcb, (u8_t *)buf, len);
121+
mp_obj_t stream = self->stream;
122+
if (stream == mp_const_none) {
123+
len = 0;
124+
} else {
125+
int err;
126+
len = mp_stream_rw(stream, buf, sizeof(buf), &err, 0);
127+
if (len > 0) {
128+
pppos_input_tcpip(self->pcb, (u8_t *)buf, len);
129+
}
117130
}
118131
}
119132

@@ -324,7 +337,9 @@ static mp_obj_t ppp_config(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs
324337
if (mp_map_slot_is_filled(kwargs, i)) {
325338
switch (mp_obj_str_get_qstr(kwargs->table[i].key)) {
326339
case MP_QSTR_stream: {
327-
mp_get_stream_raise(kwargs->table[i].value, MP_STREAM_OP_READ | MP_STREAM_OP_WRITE);
340+
if (kwargs->table[i].value != mp_const_none) {
341+
mp_get_stream_raise(kwargs->table[i].value, MP_STREAM_OP_READ | MP_STREAM_OP_WRITE);
342+
}
328343
self->stream = kwargs->table[i].value;
329344
break;
330345
}

0 commit comments

Comments
 (0)