drivers: modem: gsm: allow using custom modem setup commands #39727

bbilas · 2021-10-26T11:52:42Z

Sometimes there is a need to use a custom setup sequence for the GSM modem so add the possibility to use your own
setup_cmd structure with commands that are required.

Signed-off-by: Bartosz Bilas b.bilas@grinn-global.com

Make modem cmd macros and structures public so that applications can use them. That is also necessary for the upcoming support of custom modem setup commands. Signed-off-by: Bartosz Bilas <b.bilas@grinn-global.com>

Sometimes there is a need to use a custom setup sequence for the GSM modem so add possibility to use your own setup_cmd structure with commands that are required. Signed-off-by: Bartosz Bilas <b.bilas@grinn-global.com>

bbilas · 2021-10-26T12:06:11Z

Due to the lack of "request of review" permissions, I have to do that here.
@jukkar
@ycsin

mniestroj · 2021-10-27T08:27:04Z

include/drivers/modem/modem_cmd_handler.h

+		SETUP_CMD(send_cmd_, NULL, NULL, 0U, NULL)
+
+/* series of modem setup commands to run */
+struct setup_cmd {


Would be better to prefix that structure name with modem_. The same goes for SETUP_CMD_NOHANDLE and SETUP_CMD.

I thought that it will be better to make a change in the next MR because in that one I wanted to make those macros public only.

In order to make those macros public, we need to make sure they are in a proper namespace. So I would prefer renaming before making it public.

Make sense. Should I do a change to the namespace in the same commit which makes this header public or split it into 2 commits?

As you wish, but I think having that in 2 commits might be easier to review.

mniestroj · 2021-10-27T08:31:58Z

include/drivers/modem/gsm_ppp.h

+/**
+ * @brief Set custom modem setup commands.
+ *
+ * @param dev: gsm modem device.
+ * @param data: custom modem setup commands array.
+ * @param len: length of custom modem setup commands array.
+ *
+ * @retval None.
+ */
+void gsm_ppp_set_custom_setup_cmds(const struct device *dev,
+				   const struct setup_cmd *data,
+				   size_t len);


Is that going to be used by application or modem device drivers? Could you also elaborate or give an example how do you use that function in your case? I mean what exactly do you use as your "custom AT commands" and for what purpose?

I also wondered how to use this function yesterday, it isn't immediately clear at least, @bbilas maybe you can modify the gsm_modem sample and demonstrate a simple use case there?

It's going to be used by the application, the following example shows how I'm using it:

static const struct setup_cmd telit_setup_cmds[] = { /* Use band B20 only to speed-up registration to network */ SETUP_CMD_NOHANDLE("AT+QCFG=\"band\",0,80000,80000,1"), /* Use both NB-IoT and eMTC */ SETUP_CMD_NOHANDLE("AT+QCFG=\"iotopmode\",2,1"), /* Use NB-IoT -> eMTC scan sequence */ SETUP_CMD_NOHANDLE("AT+QCFG=\"nwscanseq\",0302,1"), /* Disable echo */ SETUP_CMD_NOHANDLE("ATE0"), }; static int modem_init(const struct device *dev) { modem = DEVICE_DT_GET(DT_NODELABEL(modem_gsm)); if (!device_is_ready(modem)) { LOG_ERR("Modem device not available!"); return -ENODEV; } /* Use custom setup commands for telit GSM modem */ gsm_ppp_set_custom_setup_cmds(modem_gsm, telit_setup_cmds, ARRAY_SIZE(telit_setup_cmds)); gsm_ppp_start(modem); return 0; }

@ycsin I agree that gsm_modem sample should contain some examples, I haven't thought about that. I will try to add it this week.

Also, not very relevant to this pr, have you ever thought about exposing the AT channel of the modem so that it is possible to configure the modem in application? i.e. enabling/disabling GPS, poll GPIO/ADC pins, modem FOTA, etc

But then we will break the API by replacing command list with callback. I would prefer callback, but let's say it is not a "must-have" from my side.

Can't we just have both options? As I know the setup commands mostly don't need extra special logic so the simple commands replacement would be enough for some cases.

@jukkar what is your opinion here?

I do not have big preference here, using callbacks sounds a bit more flexible so I am inclined to that direction. If both options are possible, then +1 to that.

@mniestroj what is your opinion about having both options? Currently I would be able to get some time to finish at least the current proposition so it's still better to have this one instead of nothing.

tautologyclub · 2021-11-04T10:54:07Z

I missed this PR because it's not prefixed with gsm_ppp, just so you know.

tautologyclub · 2021-11-04T11:00:46Z

There's many ways to accomplish this. I will try to submit a PR today with an alternative.

github-actions · 2022-01-04T00:29:07Z

This pull request has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this pull request will automatically be closed in 14 days. Note, that you can always re-open a closed pull request at any time.

HrMitrev · 2022-07-11T13:07:38Z

Hi!
I'm looking forward to the merge of this PR - it would solve many problems.
Also I was thinking if there's a way to add the custom setup commands after gsm_query_modem_info() function is finished. That way we could support multiple modems and add commands based on gsm->minfo. Now I'm modifying gsm_ppp.c and using gsm->minfo.mdm_model to branch into two different setup paths depenging on the modem used.
Cheers!

bbilas · 2022-07-11T13:18:42Z

Hi! I'm looking forward to the merge of this PR - it would solve many problems. Also I was thinking if there's a way to add the custom setup commands after gsm_query_modem_info() function is finished. That way we could support multiple modems and add commands based on gsm->minfo. Now I'm modifying gsm_ppp.c and using gsm->minfo.mdm_model to branch into two different setup paths depenging on the modem used. Cheers!

I've re-opened that MR since I'm coming back to this topic this or next week since it's needed for my project. I'll consider your suggestions and we'll see how to deal with them.

WilliamGFish · 2022-07-12T11:34:08Z

Hi! I'm looking forward to the merge of this PR - it would solve many problems. Also I was thinking if there's a way to add the custom setup commands after gsm_query_modem_info() function is finished. That way we could support multiple modems and add commands based on gsm->minfo. Now I'm modifying gsm_ppp.c and using gsm->minfo.mdm_model to branch into two different setup paths depenging on the modem used. Cheers!

I've re-opened that MR since I'm coming back to this topic this or next week since it's needed for my project. I'll consider your suggestions and we'll see how to deal with them.

Stubbled across this PR and am intrigued. I can see you are attempting to use Vendor specific AT commands as part of the modem setup which has been an issue for some time. It may be worth considering a 'library' of additional vendor specific AT commands that would be included based on manufacturer as defined in the Config, ie CONFIG_MODEM_UBLOX_SARA.
OR
Maybe the GSM aspect could be added to the actual modem driver and become a config selection (CONFIG_MODEM_UBLOX_SARA_GSM), eg the SARA would include the generic GSM commands and its vendor specific ones.

With the initialisation routine of various modem being a combination of hardware and software processes and timing creating a wholly generic driver may prove to be unrealistic and/or overly complex.

Just some thoughts.
Billy..

github-actions · 2022-09-11T00:30:14Z

This pull request has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this pull request will automatically be closed in 14 days. Note, that you can always re-open a closed pull request at any time.

bbilas added 2 commits October 26, 2021 13:50

drivers: modem: make modem cmd macros and structures public

6a223cf

Make modem cmd macros and structures public so that applications can use them. That is also necessary for the upcoming support of custom modem setup commands. Signed-off-by: Bartosz Bilas <b.bilas@grinn-global.com>

drivers: modem: gsm: allow using custom modem setup commands

e25d0a4

Sometimes there is a need to use a custom setup sequence for the GSM modem so add possibility to use your own setup_cmd structure with commands that are required. Signed-off-by: Bartosz Bilas <b.bilas@grinn-global.com>

bbilas requested review from carlescufi, galak, MaureenHelm and nashif as code owners October 26, 2021 11:52

github-actions bot added area: API Changes to public APIs area: Modem labels Oct 26, 2021

zephyrbot requested a review from rerickson1 October 26, 2021 12:01

zephyrbot assigned rerickson1 Oct 26, 2021

mniestroj requested changes Oct 27, 2021

View reviewed changes

ycsin requested a review from jukkar October 27, 2021 10:04

github-actions bot added the Stale label Jan 4, 2022

github-actions bot closed this Jan 18, 2022

bbilas reopened this Jul 7, 2022

bbilas removed the Stale label Jul 7, 2022

bbilas marked this pull request as draft July 7, 2022 15:28

github-actions bot added the Stale label Sep 11, 2022

github-actions bot closed this Sep 25, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

drivers: modem: gsm: allow using custom modem setup commands #39727

drivers: modem: gsm: allow using custom modem setup commands #39727

bbilas commented Oct 26, 2021 •

edited

bbilas commented Oct 26, 2021

mniestroj Oct 27, 2021

bbilas Oct 27, 2021

mniestroj Oct 28, 2021

bbilas Oct 28, 2021

mniestroj Oct 28, 2021

mniestroj Oct 27, 2021

ycsin Oct 27, 2021 •

edited

bbilas Oct 27, 2021 •

edited

bbilas Oct 27, 2021

ycsin Oct 27, 2021

mniestroj Oct 28, 2021

bbilas Oct 28, 2021

bbilas Oct 28, 2021

jukkar Nov 1, 2021

bbilas Nov 2, 2021

tautologyclub commented Nov 4, 2021

tautologyclub commented Nov 4, 2021

github-actions bot commented Jan 4, 2022

HrMitrev commented Jul 11, 2022

bbilas commented Jul 11, 2022

WilliamGFish commented Jul 12, 2022

github-actions bot commented Sep 11, 2022

drivers: modem: gsm: allow using custom modem setup commands #39727

drivers: modem: gsm: allow using custom modem setup commands #39727

Conversation

bbilas commented Oct 26, 2021 • edited

bbilas commented Oct 26, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ycsin Oct 27, 2021 • edited

Choose a reason for hiding this comment

bbilas Oct 27, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tautologyclub commented Nov 4, 2021

tautologyclub commented Nov 4, 2021

github-actions bot commented Jan 4, 2022

HrMitrev commented Jul 11, 2022

bbilas commented Jul 11, 2022

WilliamGFish commented Jul 12, 2022

github-actions bot commented Sep 11, 2022

bbilas commented Oct 26, 2021 •

edited

ycsin Oct 27, 2021 •

edited

bbilas Oct 27, 2021 •

edited